Document Imaging Solutions EN-DRS-7.

11-UG-20171116

Device Registration Service

Administration Guide

Version 7.11
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance® DRS 7.11 User

Guide

Document Revision Revision List

Date
November 16, 2017 7.11 Includes Nuance Unified Client for Epson v1.0.
May 19, 2017 7.10 Includes Nuance Unified Client for Samsung Smart UX and Nuance
Unified Client for Toshiba v1.0.
April 13, 2017 7.9 Patch 1 Bug fixes and minor document modifications.
February 20, 2017 7.9 Patch 1 Xerox MFPs featuring Next Generation Smart Controller.
August 22, 2016 7.6 Adds Combined Client for Ricoh with Equitrac print release, Unified Client
for Ricoh SOP.
August 03, 2016 DRS 7.5 Rebranded to Nuance.
July 25, 2016 7.7 Added Samsung XOA-Web v1.0.
April 20, 2016 DRS 7.5 Rebranded to Nuance.
April 20, 2016 DRS 7.4 Combined Clients for Konica Minolta, Ricoh, Samsung and Unified
Clients for Xerox
January 31, 2016 7.10 Samsung Smart UX.
March 11, 2015 DRS 7.0 with CAC and SNMPv3 updates

2
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

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.

Trademarks
Nuance, AutoStore, and Equitrac are 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
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Contents

Device Registration Service User Guide..............................................10

Welcome to the Device Registration Service............................................................................... 10
Using the Device Registration Service......................................................................................... 10
How to open the DRS web client...................................................................................... 10
Working with Applications.................................................................................................. 11
Working with Devices......................................................................................................... 13
Working with Device Groups..............................................................................................17
Working with client packages.............................................................................................18
Performing Actions on Devices.......................................................................................... 21
How to manage the DRS service on the server................................................................ 23
Troubleshooting Device Registration Service............................................................................... 23
Service verification..............................................................................................................27

Nuance Unified Client for Epson v1.0.................................................. 29

eCopy ShareScan Deployment.....................................................................................................29
eCopy ShareScan Solution Overview................................................................................ 29
Prepare for Deployment..................................................................................................... 30
Install the eCopy ShareScan Server..................................................................................32
Install Device Web Service................................................................................................ 35
Install Device Registration Service.....................................................................................36
Set Up Your First Capture Workflow..................................................................................38
Appendix............................................................................................................................. 40
Equitrac Deployment Guide.......................................................................................................... 44
Equitrac Solution Overview................................................................................................ 44
Prepare for Deployment..................................................................................................... 45
Install Equitrac.................................................................................................................... 47
Install Device Registration Service.....................................................................................50
Set Up Your First Print Workflow....................................................................................... 52
Appendix............................................................................................................................. 54
eCopy ShareScan and Equitrac Deployment Guide.................................................................... 58
eCopy ShareScan and Equitrac Solution Overview...........................................................58
Prepare for Deployment..................................................................................................... 59
Install the eCopy ShareScan Server..................................................................................62
Install Equitrac.................................................................................................................... 66
Install Device Registration Service.....................................................................................70
Set Up Your First Capture Workflow..................................................................................73
Set Up Your First Print Workflow....................................................................................... 74
Appendix............................................................................................................................. 76

Nuance Combined Client for Konica Minolta Client Guide.................82

Overview of the Nuance Combined Client for Konica Minolta......................................................82
Implementation Checklist: Nuance Combined Client for Konica Minolta...................................... 83
Requirements.................................................................................................................................85
Prepare the MFP to run the Nuance Combined Client for Konica Minolta................................... 86
Configure Konica Minolta OpenAPI................................................................................... 86

4
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configure MFP Auto Reset Settings.................................................................................. 87

Configure MFP for Print Release.......................................................................................89
Configuring a device to use the authentication application................................................90
Configuring the Nuance Combined Client for Konica Minolta...................................................... 93
Configure Equitrac.............................................................................................................. 93
Configure Output Manager...............................................................................................109
Configure AutoStore......................................................................................................... 123
Using the Nuance Combined Client for Konica Minolta............................................................. 125
Nuance Combined Client for Konica Minolta login......................................................... 126
How to switch between capture and print........................................................................132
How to manage print jobs................................................................................................ 133
How to configure print settings........................................................................................ 136
How to view Print Manager job information..................................................................... 138
How to start an AutoStore workflow................................................................................ 140
Reference.................................................................................................................................... 141
Nuance Combined Client for Konica Minolta application settings....................................141
Nuance Combined Client for Konica Minolta device settings.......................................... 144
Nuance Combined Client for Konica Minolta actions reference.......................................148
Return codes.................................................................................................................... 149
Restrictions and Limitations for the Nuance Combined Client for Konica Minolta...................... 151
Troubleshooting........................................................................................................................... 151

Nuance Combined Client for Ricoh.................................................... 160

Overview of the Nuance Combined Client for Ricoh.................................................................. 160
Checklist: Nuance Combined Client for Ricoh Implementation................................................. 161
Requirements...............................................................................................................................163
Configuring the Nuance Combined Client for Ricoh...................................................................165
Configure Output Manager...............................................................................................165
Configure AutoStore......................................................................................................... 175
Configure Equitrac............................................................................................................ 175
Configure Nuance Combined Client for Ricoh device properties.....................................184
Single sign-on integration.................................................................................................196
Using the Nuance Combined Client for Ricoh............................................................................198
Nuance Combined Client for Ricoh login....................................................................... 198
Screen layout....................................................................................................................208
Configuration on the device............................................................................................. 209
View Print jobs..................................................................................................................212
View Job information........................................................................................................ 213
Logout............................................................................................................................... 214
Reference.................................................................................................................................... 215
Nuance Combined Client for Ricoh application properties.............................................. 215
Device properties for Nuance Combined Client for Ricoh............................................... 217
Files tab............................................................................................................................ 222
Ricoh authentication modes............................................................................................. 222
Device Registration Service Action properties................................................................. 226
Nuance Combined Client for Ricoh actions reference.....................................................227
Import guidelines.............................................................................................................. 227
Nuance Combined Client for Ricoh return codes............................................................ 231
Restrictions and limitations......................................................................................................... 232
Troubleshooting the Nuance Combined Client for Ricoh............................................................233

5
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for Ricoh Smart Operation Panel.................. 235

Overview of the Nuance Unified Client for Ricoh Smart Operation Panel.................................. 235
Checklist: Nuance Unified Client for Ricoh Smart Operation Panel implementation................. 236
Nuance Unified Client for Ricoh Smart Operation Panel system requirements.........................238
How to configure the SSL/TLS certificates...................................................................... 239
Configuration requirements when deploying the client with third-party authentication.....241
Configuring Nuance Unified Client for Ricoh Smart Operation Panel.........................................242
Configure Output Manager...............................................................................................242
Configure AutoStore......................................................................................................... 259
Configure Equitrac............................................................................................................ 259
Reference.................................................................................................................................... 295
Application properties....................................................................................................... 295
Nuance Unified Client for Ricoh Smart Operation Panel device properties.................... 298
Files tab............................................................................................................................ 302
Nuance Unified Client for Ricoh Smart Operation Panel actions reference.................... 304
Nuance Unified Client for Ricoh Smart Operation Panel Return codes.........................307
Action Status Codes.........................................................................................................307
Troubleshooting the Nuance Unified Client for Ricoh Smart Operation Panel............................308
How to enable Home Key settings.................................................................................. 309
Device Config for AuthOff................................................................................................ 310
How to configure SP Mode settings................................................................................ 312
Paper type setup.............................................................................................................. 316
System Configuration Settings........................................................................................317
Finalize the Uninstallation............................................................................................... 319
Restarting the device........................................................................................................319
Device Logging................................................................................................................. 319

Nuance Unified Client for Samsung................................................... 321

Overview of the Nuance Unified Client for Samsung................................................................. 321
Checklist: Nuance Unified Client for Samsung implementation..................................................322
Requirements...............................................................................................................................323
Reference.................................................................................................................................... 323
Nuance Unified Client for Samsung application properties..............................................323
Nuance Unified Client for Samsung device properties.................................................... 324
Nuance Unified Client for Samsung actions reference.................................................... 325
Return codes.................................................................................................................... 325
Troubleshooting........................................................................................................................... 327

Equitrac Embedded for Samsung XOA-Web v1.0............................. 335

Overview of the Equitrac Embedded for Samsung XOA-Web v1.0............................................335
Equitrac Embedded for Samsung XOA-Web v1.0 Features............................................ 335
Supported Devices........................................................................................................... 336
Supported Card Readers................................................................................................. 336
Multi-Language Support................................................................................................... 336
Requirements....................................................................................................................336
Document Conventions.................................................................................................... 337
Installation and Configuration......................................................................................................337
Prerequisites: Before You Install...................................................................................... 338
Installation Workflow.........................................................................................................338

6
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to enable the XOA Web feature on a Samsung device...........................................339

Disabling Printing from USB............................................................................................ 339
USB Card Readers...........................................................................................................340
Server Side Configuration........................................................................................................... 341
Licensing Equitrac Embedded for Samsung XOA-Web v1.0........................................... 341
Configuring Equitrac Embedded for Samsung XOA-Web v1.0 Embedded Device.......... 343
Configuring Workflows......................................................................................................348
Tracking Jobs Originating at the Device.......................................................................... 350
Configuring Card Self-Registration...................................................................................350
Enabling Secure Printing..................................................................................................352
Configuring Follow-You Printing....................................................................................... 353
Using Equitrac Embedded for Samsung XOA-Web v1.0............................................................354
Elements of Equitrac Embedded for Samsung XOA-Web v1.0 User Interface................ 354
Logging Into Equitrac Embedded for Samsung XOA-Web v1.0...................................... 355
Launcher........................................................................................................................... 358
Using Release Key...........................................................................................................359
Using Release All............................................................................................................. 360
Using Billing Codes.......................................................................................................... 360
Using Follow-You Printing................................................................................................ 362
Using Native Copy, Fax and Scan...................................................................................364
Logging Out of Equitrac Embedded for Samsung XOA-Web v1.0.................................. 364
Settings Reference...................................................................................................................... 364
Applications Properties..................................................................................................... 364
Devices Properties............................................................................................................365
Files List............................................................................................................................367
Actions Reference............................................................................................................ 367
Device Notes............................................................................................................................... 368
Finalize the Uninstallation................................................................................................ 368
Rebooting the device........................................................................................................368

Nuance Smart UX Unified Client for Samsung.................................. 370

Overview of the Nuance Unified Client for Samsung Smart UX.................................................370
Checklist: Nuance Unified Client for Samsung Smart UX implementation................................. 371
Requirements...............................................................................................................................372
Configuring Nuance Unified Client for Samsung Smart UX....................................................... 373
Configure AutoStore......................................................................................................... 373
Configure Equitrac............................................................................................................ 374
Server Side Configuration................................................................................................ 378
Using Nuance Unified Client for Samsung Smart UX................................................................ 403
Typical User Workflows.................................................................................................... 403
Reference.................................................................................................................................... 410
Application properties....................................................................................................... 410
Nuance Unified Client for Samsung Smart UX device properties....................................412
Files tab............................................................................................................................ 415
Nuance Unified Client for Samsung Smart UX actions reference....................................415
Nuance Unified Client for Samsung Smart UX return codes..........................................416
Action Status Codes.........................................................................................................416
Quick Start........................................................................................................................ 417

Nuance Unified Client for Toshiba v1.0..............................................427

AutoStore Deployment Guide..................................................................................................... 427

7
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

AutoStore Solution Overview........................................................................................... 427

Prepare for Deployment................................................................................................... 428
Install the AutoStore Server............................................................................................. 430
Install Device Web Service Standalone........................................................................... 430
Setup the Toshiba MFP....................................................................................................431
Install Device Registration Service...................................................................................432
Set Up Your First Capture Workflow................................................................................435
Equitrac Deployment Guide........................................................................................................ 437
Equitrac Solution Overview.............................................................................................. 437
Prepare for Deployment................................................................................................... 438
Install Equitrac.................................................................................................................. 440
Setup the Toshiba MFP....................................................................................................443
Configure Device Registration Service............................................................................ 444
Set Up Your First Print Workflow..................................................................................... 446
AutoStore and Equitrac Deployment Guide................................................................................449
AutoStore and Equitrac Solution Overview......................................................................449
Prepare for Deployment................................................................................................... 450
Install the AutoStore Server............................................................................................. 452
Install Equitrac.................................................................................................................. 453
Setup the Toshiba MFP....................................................................................................455
Configure Device Registration Service............................................................................ 456
Set Up Your First Capture Workflow................................................................................459
Set Up Your First Print Workflow..................................................................................... 461
Reference.................................................................................................................................... 463
Device properties for Nuance Unified Client for Toshiba v 1.0........................................ 463
Nuance Unified Client for Toshiba v 1.0 actions reference.............................................. 465
Nuance Unified Client for Toshiba v 1.0 application properties....................................... 466

Nuance Unified Client for Xerox......................................................... 468

Overview of the Nuance Unified Client for Xerox.......................................................................468
Web client......................................................................................................................... 469
Checklist: Nuance Unified Client for Xerox implementation....................................................... 469
Requirements...............................................................................................................................470
Configuring Nuance Unified Client for Xerox..............................................................................470
Device Registration Service............................................................................................. 470
Configuring authentication................................................................................................ 472
Using the Nuance Unified Client for Xerox.................................................................................474
Log on to the Nuance Unified Client for Xerox................................................................475
View job properties...........................................................................................................476
View or configure job settings..........................................................................................477
Application navigation..................................................................................................................477
Log on to the Nuance Unified Client for Xerox................................................................477
Secure Print page.............................................................................................................479
Properties page................................................................................................................ 480
Settings page....................................................................................................................481
Reference.................................................................................................................................... 482
Nuance Unified Client for Xerox application properties................................................... 482
Nuance Unified Client for Xerox device properties.......................................................... 483
Import properties...............................................................................................................485
Nuance Unified Client for Xerox Actions reference......................................................... 486
Command buttons............................................................................................................ 487
Return codes.................................................................................................................... 487

8
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Troubleshooting Nuance Unified Client for Xerox.......................................................................489

9
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Device Registration Service

User Guide

Welcome to the Device Registration Service

The Device Registration Service web-based interface enables you to manage Applications, Devices,
and Device groups. Use the Device Registration Service to register Unified Clients on devices. A Unified
Client is a component that merges print management and capture on a device. The device properties
determine the scan and print functions that are available to users.
Configuring a Unified Client through Device Registration Service consists of the following high-level
steps:
1. Add an Application for a Unified or Combined Client type and configure the Application properties.
2. Add Devices and configure their properties.
3. If necessary, add Device groups to organize Devices with the same Application in the groups.
4. Run an Action to register or install the Unified or Combined Client on the MFP or MFD.
System configuration procedures vary depending on your business requirements and the Unified or
Combined Client type. Refer to the section for the Unified or Combined Client type for details.
If you have not already downloaded the Device Registration Service installation package, it can be
downloaded from the Equitrac Partner Portal or from the Web Licensing Portal. For instructions on
how to install Device Registration Service, you can download the installation guide from either of these
locations.

Using the Device Registration Service

This section describes how to create and work with Applications, Devices, and Actions in Device
Registration Service.

How to open the DRS web client

Use the DRS Web Client to install or register and manage Nuance unified or combined clients on
multifunction printers.
The Web Client URL is used to open the DRS Web Client in a web browser. The Web Client URL is
displayed in the Service settings in the DRS Device Configuration Manager. This URL is in the following
format:

10
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

http://server-address:client-port/device/

Option Description

server-address An IP address, a system name (if the systems are

in the same domain), or a fully qualified domain
name. When working on the server itself, you can
use localhost.

client-port The port used by the server to communicated

with the web client. This port is specified in the
Service settings in the DRS Device Configuration
Manager. The default value is 9000.

Note: To access the DRS Web Client, or to avoid being prompted for user credentials, you may
need to add the URL to the list of Local intranet sites configured on the Security tab of the Internet
Options in the Windows Control Panel. You may also may also need to open the Custom settings
for Local intranet sites on the same tab and configure the User Authentication setting as necessary to
avoid being prompted for credentials to access the local intranet site.

Perform the following steps to open the DRS Web Client.

1. Enter the Device Registration Service Web Client URL in an internet browser.
For example, if the system name for the server is "DRS-Server", navigate to http://DRS-
Server:9000/device/.
This opens the Device Registration Service Web Client page in the browser.
Tip: If the page fails to open, make sure that the Nuance Device Registration Service is running
on the DRS server and that the web browser security settings permit opening a web page from the
specified location.
2. After you open the DRS Web Client, you can click Language on the toolbar to switch to a different
language, Options to refresh or change view characteristics, or Help to view help topics for DRS
and the unified or combined clients.

Working with Applications

An Application profile is defined for a particular device type. Device types correspond to device brands.
The Application profile specifies server information that can be associated with multiple devices. Server
information can include the address information for both scan and print manager servers. The scan
manager is AutoStore, which in addition to scanning, provides extensive documentation process and
route functionality. The print manager can be either Equitrac or Output Manager (not supported in
Nuance Unified Client for Samsung Smart UX).

How to add an Application profile

This task describes how to add an Application profile in Device Registration Service.
1. Open Device Registration Service web client in a supported internet browser window if it is not
open already.
If you are not certain about how to do this, see How to open the DRS web client on page 10.
2. On the toolbar, click Applications.
3. On the Applications toolbar, click the add button .
4. In the Name box, enter a name to uniquely label the Application.
This displays Application settings that depend on the selected Application type.

11
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. In the Application Type box, choose the client type.

Client Choose
Nuance Unified Client for Epson v1.0 Epson Unified Client
Nuance Combined Client for Konica Minolta Konica Minolta iOption
Nuance Combined Client for Ricoh Ricoh ESA
Nuance Unified Client for Ricoh Smart Ricoh SOP
Operation Panel
Nuance Unified Client for Samsung Samsung XOA
Nuance Unified Client for Samsung Smart UX Samsung SmartUX
Equitrac Embedded for Samsung XOA-Web Samsung XOA-Web
v1.0
Nuance Unified Client for Toshiba v 1.0 Toshiba Unified Client
Nuance Unified Client for Xerox Xerox EIP Connect
6. Configure settings for the selected device type. Click one of the following topics for details.
• Nuance Unified Client for Epson v1.0 Application settings
• Nuance Combined Client for Konica Minolta Application settings
• Nuance Combined Client for Ricoh Application settings
• Nuance Unified Client for Ricoh Smart Operation Panel Application settings
• Nuance Unified Client for Samsung Application settings
• Nuance Unified Client for Samsung Smart UX Application settings
• Equitrac Embedded for Samsung XOA-Web v1.0 Application settings
• Nuance Unified Client for Toshiba v 1.0 Application settings
• Nuance Unified Client for Xerox Application settings
7. After you finish configuring settings for the Application, click the save button on the toolbar.
The new Application profile is listed in the Applications pane. You can now refer to it with the
Application setting in Device profiles.

How edit Application profile settings

This task describes how to configure an Application profile in Device Registration Service.
1. Open Device Registration Service web client in a supported internet browser window if it is not
open already.
If you are uncertain about how to do this, see How to open the DRS web client on page 10.
2. Click the Applications button on the toolbar.
3. In the Applications pane, click the Application you want to edit.
This displays settings for the Application properties in the Details pane.
4. In the Details pane, click the edit button .
5. Edit settings for the Application type. Refer to one of the following topics for additional information.
• Nuance Unified Client for Epson v1.0 Application settings
• Nuance Combined Client for Konica Minolta Application settings
• Nuance Combined Client for Ricoh Application settings
• Nuance Unified Client for Ricoh Smart Operation Panel Application settings
• Nuance Unified Client for Samsung Application settings

12
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Nuance Unified Client for Samsung Smart UX Application settings

• Equitrac Embedded for Samsung XOA-Web v1.0 Application settings
• Nuance Unified Client for Toshiba v 1.0 Application settings
• Nuance Unified Client for Xerox Application settings
6. After you finish making changes, click the button.
You can click the button to revert to the previously saved settings.
The edited Application will be listed in the Applications pane and the updated settings will appear in the
Details pane. If necessary, click the button to view changes.

Working with Devices

A DRS Device profile defines settings for a particular MFP or MFD on your network. Settings in a Device
profile depend on the Application profile selected in the Device settings. After you define a Device
profile, you can use it to install the Nuance imbedded client on the associated device. Device profiles
allow you to manage devices from a central location. This includes authentication, status information,
and client updates. You can define Device groups that propagate settings to multiple devices.

How to add a new Device profile

This task explains how to create a Device profile. The profile enables you to manage Unified Client,
AutoStore, Equitrac or Output Manager, and authentication settings on the Device through Device
Registration Service.
1. Open Device Registration Service web client in a supported internet browser window if it is not
open already.
If you are uncertain about how to do this, see How to open the DRS web client on page 10.
2. On the toolbar, click Devices.
3. On the Devices toolbar, click the add button .
4. In the Name box, enter a name to uniquely label the Device profile.
5. In the Address box, type an IP address for the MFP or MFD to associate it with this Device profile.
This option is specific to a Device and does not appear when you configure properties for a Device
group.
6. In the Username box, type the administrator user name for the Device.
The default is admin.
The user name is not required to complete a profile, but may be required to perform Actions on a
device.
7. In the Password box, type the password associated with the user name.
8. In the Application box, select the Application to associate with the Device profile.
The Application setting specifies an Application profile listed on the Applications tab. This defines
the client type and server configurations for a device.
9. Edit settings for the Application Device type. Refer to one of the following topics for Device
configuration details for a particular client.
• Nuance Unified Client for Epson v1.0 Device settings
• Nuance Combined Client for Konica Minolta Device settings
• Nuance Combined Client for Ricoh Device settings
• Nuance Unified Client for Ricoh Smart Operation Panel Device settings
• Nuance Unified Client for Samsung Device settings
• Nuance Unified Client for Samsung Smart UX Device settings

13
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Equitrac Embedded for Samsung XOA-Web v1.0 Device settings

• Nuance Unified Client for Toshiba v 1.0 Device settings
• Nuance Unified Client for Xerox Device settings
10.Click the save button on the Add Device toolbar.

How to edit a Device

This task describes how to edit settings for an existing Device profile.
1. Select the Device profile in the Devices pane.
2. Click the edit button on the Details toolbar.
3. Edit the Device profile properties as required.
4. Edit settings for the Application Device type. Refer to one of the following topics for Device
configuration details for a particular client.
• Nuance Unified Client for Epson v1.0 Device settings
• Nuance Combined Client for Konica Minolta Device settings
• Nuance Combined Client for Ricoh Device settings
• Nuance Unified Client for Ricoh Smart Operation Panel Device settings
• Nuance Unified Client for Samsung Device settings
• Nuance Unified Client for Samsung Smart UX Device settings
• Equitrac Embedded for Samsung XOA-Web v1.0 Device settings
• Nuance Unified Client for Toshiba v 1.0 Device settings
• Nuance Unified Client for Xerox Device settings
5.
Click the save button on the Details toolbar.

Changing languages on Device

This procedure describes how to change languages on eBN and eBX devices.
Change language on eBN Device
This procedure describes how to change languages on eBN device.
In order to change language on eBN device:
1. Log in to Nuance application.
2. Press the [Home] button on the control panel.
3. Select user functions on screen.
4. Press the [Admin] tab at the bottom of your screen.
5. Press [General] and go to the next screen.
6. Press the [Languages] button and choose a language.
7. Press [Set as default] and OK.
Change language on eBX Device
This procedure describes how to change languages on eBX device.
In order to change language on eBX device:
1. Press the [User Function] button on the control panel to enter admin password.
2. Press the [General] button and go to the next screen.
3. Press the [Languages] button and choose a language.
4. Press [Set as default] and OK.

14
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Filter Device and group information

The Filter pane allows you to filter the view in the Device pane.
Use these settings on the Filter pane to filter Device and Device group information. The following table
describes the filters that you can apply. To apply a filter, click the apply button on the Filter toolbar.
To clear a filter, click the clear button .

Entry Description

Name The name of the Device group or Device.

Address The IP address of the Device.

Device Type Click to choose the device type.

Property Click to choose a property for the Device.

Property Value Click or type to specify the value for the property
setting.

How to import Device information

This task explains how to import Device information into Device Registration Service from Output
Manager or a CSV file.
The Application name and type specified for an imported Device must match the name and type of
an existing Application on the DRS server where you want to import a Device. The import will fail for
a Device if there is no Application on the server with the name and type specified in the DRS Device
export file. In a DRS export file, the Application name and type correspond to the values specified in a
Device entry by the ApplicationProfile and DeviceType fields.
1. In your web browser, open the Device Registration Service web client.
For more information, see How to open the DRS web client on page 10.
2. Click Devices.
3. Click the import button on the Devices toolbar and select the import method:
Click To
Import from OM Import Device information from the Output
Manager server.
Type the address of the Output Manager server,
select the Application profile, and click Import
from OM. Device Registration Service only
imports Devices that are marked as Unified
Client Devices in Output Manager.

Import from file To import Device information from a CSV file

that was contains previously exported Device
information.
Browse to the CSV file and click Upload.

15
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

The Import Results window shows success or failure for each Device that was specified in the DRS
export file and a message for Devices that were not imported successfully.
4. Close the Import Results window after you review the results of the import.
5. If necessary, edit properties for imported Devices.
For more information, see How to edit a Device on page 14
Imported Devices are always added to the root Devices folder. After you successfully import a Device,
you can optionally drag it to a group folder with the same Application profile. For more information, see
How to add an existing Device to a Device group on page 17.

How to export Device information

This task explains how to export Device information to a CSV file.
This procedure exports all Devices in the current view to a comma separated value (CSV) formatted file.
1. Click Devices.
2. If necessary, apply a Filter to limit the Devices shown in the Devices pane.
For more information, see Filter Device and group information on page 15.
3. On the Devices toolbar, click the export Devices button .

Device Registration Service exports the Device information to a CSV file in the following format:
Name, IP, Application, Device Group, Property Name=Property Value, Inherit
Property From Group, Serial Number, Username, Password
Tip: When you do not have an export file that contains the Device information that you want to
use, you can use an exported CSV file as a template to assemble the required Device information
for import.

Device Registration Service Device Status

When a Device profile is selected on the Device tab on the Device Registration Service client web
page, the Status bar in the Details pane displays the current device status for the Unified Client
application and scan GUI service. Click the refresh button on the Status bar to display the current
status for a device. The message shows Device not reachable if the IP address is not valid or the
device is currently not visible on the network.

Unified Client Application Scan GUI Service Status Status Message

Status

Installed Installed Installed; Version:

Client: version - Scan
GUI Service: version

Installed Not installed Installed; Version:

Client: version -
Scan GUI Service: Not
installed

16
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Unified Client Application Scan GUI Service Status Status Message

Status
Installed Error Installed; Version:
Client: version - Scan
GUI Service: Error
message

Not Installed Not Installed Not Installed

Not Installed Installed Not Installed

Error Error message

Working with Device Groups

Device groups define groups of Devices. By default, all Devices in a group inherit settings from the
group. Optionally, you can disable inheritance for a Device to configure its settings individually.

How to add a Device group

This task explains how to create a group to organize Devices in Device Registration Service. The
Device group is a single configuration point for managing multiple Devices for an Application.
1. Click Devices.
2. On the Devices toolbar, click the add Device group button .
3. Enter the Name, Username and Password for the Device group.
4. From the drop-down list box, select the target Application.
5. Configure Device group properties.
Devices and Device groups share properties. Refer to Device properties for a particular client type:
• Unified Client for Epson Device properties
• Combined Client for Konica Minolta Device properties
• Combined Client for Ricoh Device properties
• Unified Client for Ricoh SOP Device properties
• Unified Client for Samsung Device properties
• Samsung Smart UX Device properties
• Samsung XOA-Web Device properties
• Unified Client for Toshiba Device properties
• Unified Client for Xerox Device properties
6. On the Add Device Group toolbar, click the save button .

How to add an existing Device to a Device group

This task explains how to add an existing Device to a Device group.
For you to successfully add an existing Device to a Device group, the Device profile must specify the
same Application as the Device group.
1. Click Devices.
Click the existing Device and drag it to the Device group folder.
2.
You may have to click the refresh button to view the change.

17
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to add a new Device profile to a Device group

This procedure describes how to create a new Device in a Device group.
Context for the current task
1. Click Devices.
2. Click the Device group folder where you want to add a Device profile.
3. On the Devices toolbar, click the add button .
4. In the Name box, enter a name to uniquely label the Device profile.
5. In the Address box, type an IP address for the MFP or MFD to associate it with this Device profile.
This option is specific to a Device and does not appear when you configure properties for a Device
group.
6. Specify the Inherit Properties from Group value:
• To inherit properties from the Device group, select True.
• To configure specific Device properties, select False and configure the properties for the Device.
Devices and Device groups share properties. Refer to Device properties for a particular client type:
• Unified Client for Epson Device properties
• Combined Client for Konica Minolta Device properties
• Combined Client for Ricoh Device properties
• Unified Client for Ricoh SOP Device properties
• Unified Client for Samsung Device properties
• Samsung Smart UX Device properties
• Samsung XOA-Web Device properties
• Unified Client for Toshiba Device properties
• Unified Client for Xerox Device properties
7. Click the save button .

Working with client packages

Client packages contain all client files that will be installed by a Device Action on Device. Packages
uploaded to Device Registration Service appear on the web client Files tab. Packages listed on this
tab can be specified by the Application/Client Package option in the Device profile for a Device
Registration Service Device. If the Device profile settings do not include the Application/Client
Package option, then client packages are not supported for the device type.
Device installation packages are typically downloaded from the Equitrac Partner Portal or from the Web
Licensing Portal. After you download a client package, you upload it to the Device Registration Service.
This copies the package files to the plug-in folder for the device type.
In the Device Registration Service web client, select the correct Device Type on the Files tab, and then
click the Upload button to upload the client package files. During an upload, a selected file is copied to
the corresponding device type folder in the Device Registration Service Plugins folder:
C:\Program Files (x86)\Nuance\Device Registration Service\Service\Plugins
The following plug-in folders are currently added the Plugins folder during the installation of the Device
Registration service.

18
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Table 1: Device plug-in folders

Device Type
* Plug-in folder

Nuance Unified Client for Epson v1.0 NSi.DeviceManagement.Plugins.Epson

Nuance Combined Client for Konica NSi.DeviceManagement.Plugins.Konica
Minolta
Nuance Combined Client for Ricoh NSi.DeviceManagement.Plugins.Ricoh
Nuance Unified Client for Ricoh Smart NSi.DeviceManagement.Plugins.RicohSOP
Operation Panel
Nuance Unified Client for Samsung NSi.DeviceManagement.Plugins.Samsung
Nuance Unified Client for Samsung NSi.DeviceManagement.Plugins.Samsung.SmartUX
Smart UX
Samsung XOA-Web NSi.DeviceManagement.Plugins.Samsung.XoaWeb
Nuance Unified Client for Toshiba v 1.0 NSi.DeviceManagement.Plugins.Toshiba
Nuance Unified Client for Xerox NSi.DeviceManagement.Plugins.XeroxEx

You can view the uploaded files by clicking the refresh button on the Files tab. Files referenced
in one of the XML group definition files will appear in a group folder. Unreferenced files appear in the
Ungrouped folder. The groups shown here are listed in the Application Package option in the Device
settings for the associated device type.

Files list (Unified Client installation packages)

The Files tab in the Device Registration Service web client lists available Unified Client installation
packages for devices. A package in this list may be specified in the DRS Device profile for a Unified
Client.
You can upload, rename, and remove Unified Client installation packages on this list.

Option Description

Device Type Filters device installation packages to be

displayed. Choose the device type on which you
want to install a Nuance Unified Client.

*
Note that creation of folders in this location does not signify availability of client installation
packages for a particular Unified or Combined Client.

19
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
File list Lists client installation package files that have
been uploaded for the selected Device Type to the
Device Registration Service.
• Name shows the name of an uploaded
installation package file.
• Date Modified date-time stamp shows when
an installation package was last modified.
• Size shows the size of an uploaded installation
package file in bytes (B), kilobytes (KB), or
megabytes (MB).
Click the expand button to view details for a
installation package file. Details can vary, but
typically includes information such title, vendor,
telephone, fax, email, application version, and
product ID.

Click this button to rename a selected installation

Rename
package file in the list.

Click this button to remove a selected installation

Remove Item
package file from the list.

Upload Click this button to add an installation package

to the DRS server. You must first download the
package to a local drive from the Equitrac Partner
Portal or from the Web Licensing Portal.

How to upload a Unified Client installation package to DRS

This procedure describes how to upload Unified Client installation packages downloaded from a Nuance
download portal. An installation package is specified in the Unified Client Device settings.
Before you perform this procedure, you must acquire the Unified Client installation package that you
want to upload to the Device Registration Service. After you download a package, unpack the ZIP and
XML files included in the package, and use this procedure to upload all of the files in the package.
1. Download the Unified Client installation package from the Equitrac Partner Portal or from the Web
Licensing Portal web page.
The download file will be a single ZIP file.
2. Unpack the ZIP and XML files packaged in the download file.
3. If the Device Registration Service web client page is not already open, browse to the URL in your
web browser.
For instructions on how to open the Device Registration Service web client, see How to open the
DRS web client on page 10.
4. In the Device Registration Service web client, click the Files tab.
5.
At the bottom of the browser window, click the upload button Upload button.

20
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. In the Upload dialog box, click Select file, and locate a client file in the package file that you
downloaded from Nuance.
7. Click Open.
8. Repeat steps 5 through 7 for each file in the downloaded package.
9. After you finish uploading all of the files in the client installation package, you can click the refresh
button on the Files tab to view the uploaded packages.

If the uploaded files do not appear on the Files tab after you click the refresh button , make sure
that the correct device type is selected in the Device Type box.
After you complete this procedure, the groups listed here will be listed in the Application Package
option in the Device profile settings for the associated device type.

How to remove a package file from DRS

1. Open Device Registration Service web client in a supported internet browser window if it is not
open already.
If you are not certain about how to do this, see How to open the DRS web client on page 10.
2. On the toolbar, click Files tab.
3. Click the file that you want to remove.
4.
Click the Remove Item button.
5. Repeat step 3 on page 21 through step 4 on page 21 in this procedure to remove all files in a
package.

How to rename a package file in DRS

This procedure describes how to rename a package file after it is uploaded to the Device Registration
Service.
1. Open Device Registration Service web client in a supported internet browser window if it is not
open already.
If you are not certain about how to do this, see How to open the DRS web client on page 10.
2. On the toolbar, click Files tab.
3. Click the file that you want to rename.
4.
Click the Rename button.
This displays the Rename dialog box.
5. Type the new name for the file.
Be careful to retain the .xml or .zip extension on the file name.
6. Click the Save button.
Completing this procedure changes the name of the file in the device plug-in folder.

Performing Actions on Devices

How to perform Device Actions
1. In your web browser, open the Device Registration Service web client.
See How to open the DRS web client on page 10.
2. Click Devices.
3. Select a Device.

21
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

To perform an Action on all Devices in a group, select the group folder.

4. On the Details toolbar, select the Action that you want to perform on the selected Device or group.
The Actions available in this list depend on the client type:
• Nuance Unified Client for Epson v1.0 Actions
• Nuance Combined Client for Konica Minolta Actions
• Nuance Combined Client for Ricoh Actions
• Nuance Unified Client for Ricoh Smart Operation Panel Actions
• Nuance Unified Client for Samsung Actions
• Nuance Unified Client for Samsung Smart UX Actions
• Equitrac Embedded for Samsung XOA-Web v1.0 Actions
• Nuance Unified Client for Toshiba v 1.0 Actions
• Nuance Unified Client for Xerox Actions
5.
Click the run button.

How to view Action history

1. In your web browser, open the Device Registration Service web client.
See How to open the DRS web client on page 10.
2. Click Devices.
3. To filter Device and Device group information that appears in the Devices pane, type or select
criteria in the Filter pane and click Apply.
4. To view Action history for a Device or Device group, select the Device or Device group in the Details
pane.
The Action History pane shows the following information:

Option Description
Time Time stamp of when the Action was attempted.

Action Attempted Action.

Message Action taken and the result.

Status Status for the Action.

Success Indicates if the Action was successful.

Device Name of the device.

Address IP address of the device.

Return code Return code returned by the device. The values

shown on the device type.

22
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to manage the DRS service on the server

Use the Nuance Device Configuration Manager to configure, start, and stop the Nuance Device
Registration Service.
Use this procedure to configure settings for the Device.
1. On the host machine for the Device Registration Service server, click Start > All Programs >
Nuance > Device Registration Service > Device Configuration Manager.
2. Click Yes when prompted whether you want to allow changes to the computer.
This opens Device Registration System Configuration dialog box.
3. Configure settings for the Nuance Device Registration Service properties on the Service, Security,
and Administration tabs.
For details about options on these tabs and troubleshooting tips, click the Help button.
In the Windows Services console, you can start, stop, pause or resume a service. However, you need
to use the Device Registration Service Configuration Manager to configure the Database Connections
and Service Settingsoptions, the Security options, and Administration logging options for the Device
Registration Service, as these settings are not accessible through the Windows Services console.

Troubleshooting Device Registration Service

The following table provides troubleshooting information for the Device Registration Service and the
Device Registration Service web client:

Description Cause Solution

Windows service does not start. One or more configuration If the Windows service has
settings may be invalid. been set to run under a network
account, ensure the account has
local administrator permissions.
If connecting to SQL Server,
click Verify under Properties
to ensure the connection
information is valid.

Web client reports service is The Windows service that hosts Use the Nuance Device
down. the Web service may not have Management Configuration
been started or was unable to Tool to ensure that the Web
start. service has been started. If the
service fails to start, verify the
database connection by clicking
Verify in database properties.
Ensure the Service Port number
set in the Service tab of the
Nuance Device Management
Configuration Tool is not in use
elsewhere.

23
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Description Cause Solution

Web client reports access is The user does not belong to Add the user to the Window
denied. the Access Group set in the group set with the Access
Nuance Device Management Group field on the Service tab
Configuration Tool. of the configuration tool, or clear
the Access Group field to allow
all users.

Application does not appear in The Application profile for the Create an Application profile in
the Application drop-down list specific device type has not been the Application section of the
box when creating a Device. created. Web client. When prompted for
Application Type, select the
option that matches the type
of device for which you want to
create a Device profile.

Importing Devices reports Imported file is not in CSV Verify that the imported file is
Application Profile was not found format, or does not follow the a text file in comma separated
for all rows. expected import format. value (CSV) format with the
.csv extension. If you are using
Microsoft Excel, use the Save
As option to save the file as a
CSV file.
Import headers should appear
in the following order: Name,
IP, ApplicationProfile,
DeviceType,
DeviceGroup, Properties,
InheritPropertyFromGroup,
SerialNumber, Username,
Password. Refer to the import
guidelines topic in the section for
your Unified Client type for more
information.

24
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Description Cause Solution

Web client does not connect to File path to certificate is invalid, Use the Nuance Device
service when SSL is enabled. or the password is incorrect. Management Configuration
Tool to verify the Certificate
Path and Certificated
Password settings on the
Security tab. Ensure that the
httpCfg.exe utility has not
been removed from under the
Service folder of the Device
Registration Service installation
folder.

Advanced With the

Windows
service stated,
verify the
certificate has
been installed
in the local
Windows
certificate
store. A
self-signed
certificate
should be
found under
Personal
Certificates
on the local
machine.

Cannot connect to Web client File path to certificate is invalid, See Web client does not connect
when SSL is enabled. or the password is incorrect. to service when SSL is enabled
in this table for more information.

Web client does not load in the One or more configuration Use the Nuance Device
browser. settings may be invalid, or the Management Configuration
service is not started. Tool to verify that the Client Port
number set on the Service tab is
not in use elsewhere.
Verify that the service has been
started, then use the Web client
link at the bottom of the Service
tab in the Nuance Device
Management Configuration
Tool to launch the Web client.

25
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Description Cause Solution

Get an Error in Opening FIPS was enabled without Close Device Configuration
Window error message when clearing the SSL settings. Manager and then disable FIPS.
starting Device Configuration Start Device Configuration
Manager. Manager, select the Security
tab, clear the Enable SSL on
Web Service and Enable SSL
on Web Client options, and then
enable FIPS.

The Nuance Device Registration The Device Configuration After you specify to run the
Service fails to start after valid Manager failed to register the service under a domain user
user credentials are specified domain user credentials with the account in the DRS Device
for Network Account on the Windows service manager. This Configuration Manager, start it
Service tab of the DRS Device is a known issue. for the first time in the Windows
Configuration Manager. Services administrative console:
The Device Configuration 1. Open Control Panel >
Manager displays an error Administrative Tools >
message that Service Services.
credentials are invalid 2. In the Name column,
when you try to start the service double-click Nuance Device
in Service Actions using a valid Registration Service.
domain user account. 3. On the Log On tab, make
sure that that the domain
user account credentials are
correctly specified for This
account.
4. On the General tab, click
Start.
5. Click OK.
You will subsequently be able
to start the service with the
specified credentials in the DRS
Device Configuration Manager.

26
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Description Cause Solution

Unhandled exception error The network account used to run Provide the Full Control
occurs when creating an the DRS service requires Full permission for the network
Application or adding a Device Control permissions to LocalDB account that runs the DRS
when you use a network account database files used by DRS. service to the following two files
to run the DRS service. in the DRS Services folder:
• DRS_LDB.mdf
• DRS_LDB_log.ldf
The network account that runs
the DRS service is specified on
the Service tab of the Device
Registration Configuration
Manager. These are located in
the following folder (when DRS is
installed in the default location):
C:\Program Files
(x86)\Nuance\Device
Registration Service
\Service.

Service verification
You can verify the Device Registration Service Web Service by using the DRS Service Tester
utility (NSi.DeviceManagement.ServiceTester) located in the Service subfolder of the Device
Registration Service installation folder (for example, C:\Program Files\Nuance\Device
Registration Service\Service\).

27
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 1: Service Tester dialog box

The utility requires the service address to verify the presence of the web server. Entering a service
address and clicking the Get Device Configurations returns an Object not found error message. If
the service is not available at the specified address, a communication error appears.
The Device Registration Service Web Service address for the Unified Client is:
http://server name or IP address:port number/DeviceManagementService/
transfer
The Device Registration Service Web Client address formula for the Device Registration Service Web
Client is:
http://server name, or IP address:port number/DeviceManagementService/
Note: The default port for the Device Registration Service Web Service is port 8753. You can use the
Device Registration Service Configuration Tool to change the default port.

To verify the presence of the Web Service and a registered device, enter the Service Address and
Device Address, and then click Get Device Configurations. A device address in this instance may be
either an IP address or a server name. You can specify the host computer name for the Web Service
in the Optional Device Host box. The utility uses the host name to look up the device in the Device
Registration Service repository if the specified Device Address is not found. If the device is not found
in the Device Registration Service repository, an Object not found message appears. If the device is
found, its properties appear.

28
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for

Epson v1.0

eCopy ShareScan Deployment

eCopy ShareScan Solution Overview
Version 1.0 of the Nuance Unified Client for Epson provides a unified client for capture and print
management functionality on specific Epson-manufactured Multi-Function Printers (MFPs). When
deployed to the MFP, Nuance Unified Client for Epson v1.0 controls access to the MFP, and acts as the
gateway for Nuance functionality.
Nuance eCopy ShareScan is a server-based solution designed to drive an increase in office productivity
while decreasing the environmental footprint through automation of paper-intensive processes using
Epson MFPs. eCopy ShareScan empowers workgroups and enterprises to capture the data in paper
documents easily and securely using Epson Open Platform (EOP) enabled MFPs.
This document will walk you through a clean installation procedure in eCopy ShareScan standalone
deployment. Also described is how to set up your first scan capture workflow (Scan to File) on your
Epson MFP device.
To learn more, refer to Device Registration Service (DRS) and eCopy ShareScan documentation when
performing server-side configuration tasks.

Basic workflow
1. Prepare for deployment
a. Verify that your device is supported
b. Verify prerequisites
c. Get installer packages (eCopy ShareScan, DWS and Device Registration Service)
2. Install the eCopy ShareScan server
3. Install Device Web Server (DWS) standalone
4. Configure the Epson MFP
5. Install and Set Up Device Registration Service (DRS)
a. Register the Epson device using DRS in eCopy ShareScan-only deployment
b. Verify that previous applications are cleared
c. Create application.
d. Add the device

29
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

e. Register
6. Configure your first workflow and verify installation
a. License eCopy ShareScan
b. Configure Scan to File workflow

Prepare for Deployment

Verify that your device is supported
Nuance Unified Client for Epson v1.0 works on Epson MFPs that support the Epson Open Platform
(EOP) version 1.1.
For the latest list of supported Epson models, consult your local Epson representative or refer to
Nuance Supported Device Search webpage (https://nuanceimaging.custhelp.com/app/imaging/
supported_devices).

Verify prerequisites
Before starting deployment ensure that the following requirements are met. These are targeting a
satisfying user experience when you are doing a single-server installation.

Check Description

Verify that the sever machine is the member of a domain.

Ensure that the following hardware requirements are met:

• 8 GB of physical memory available
• 5 GB of hard disk space available (including SQL server and prerequisites)
• The CPU is 4 x 2 GHz or greater

Check that database is SQL server 2008 or above, express and non-express editions.

Check that the operating system is one of the following 64-bit ones:
• Windows Server 2008 R2 SP1 (64-bit support as a 32-bit application)
• Windows Server 2012 R2 (64-bit support as a 32-bit application)
• Windows Server 2016 (64-bit support as a 32-bit application)

Ensure that the eCopy ShareScan install media contains all the required dependency
installer files under Install\ShareScan\SetupPrerequisites\ in separate folders that must
be installed to ensure eCopy ShareScan functions properly. These are the following:
• Java SE Runtime Environment 8 Update 131 (x86) – version 8.0.1310.11
• Microsoft .NET Framework 3.5
• Microsoft .NET Framework 4.6.2
• Microsoft Visual C++ 2012 Redistributable (x86) – version 11.0.61030
• Microsoft Visual C++ 2015 Redistributable (x86) – version 14.0.24123
• Microsoft Visual C++ 2015 Redistributable (x64) – version 14.0.24123
• Microsoft Visual J# 2.0 Redistributable

Verify that you have Administrative access rights to Windows on the server.

30
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description

Check that all required Windows updates are installed.

Verify that Microsoft Windows Updates is turned OFF while you are deploying
eCopy ShareScan. (This is necessary for the successful installation of Microsoft
Windows Identity Foundation (TFS).

Allow incoming firewall exceptions for the following ports:

• 80: Device port used for HTTP connections.
• 443: Device port used for HTTPS connections to the device.
• 8080: Redirects to port 8443 used for HTTPS communication to the DWS.
• 8443: Each request to the DWS from the MFP uses the DWS address as specified
in DRS (TLS connections using port 8443). It is these requests and events from the
MFP to DWS that will request the DWS server certificate when completing a TLS
handshake. Also used by Web Administration page.
• 8753: The default port for the Device Registration Service Web Service.
• 9000: The port used by the server to communicate with the web client. This port is
specified in the Service settings in the DRS Device Configuration Manager.
• 9655/9656: Epson eCopy ShareScan SSL port is changed automatically to 9656
when SSL is enabled and back to 9655 when SSL is false. The default port is 9655.

Verify that Administrators are turned OFF under IE Enhanced Security Configuration
(to access this, go to Server Manager > then select Local Server).

Check that you have all required components downloaded and within easy reach.

If you are planning to use any eCopy ShareScan Connector that requires client
software, ensure that this software is installed on your server machine before starting
deployment.

Verify that you have Administrative access to the MFP device.

Check that Device Web Server (DWS) standalone is installed on a different server than
eCopy ShareScan.
Note: Under certain circumstances and scenarios (in case no other web-based
client or simulator is used), DWS and eCopy ShareScan can reside on the same
server.

Get installer packages

The following components are required for installing the Nuance Unified Client for Epson v1.0 software
in eCopy ShareScan Deployment:
• eCopy ShareScan 6.1 or later with all available hotfixes installed: Log in to the eCopy
Product Registration Portal (http://registration.ecopy.com/login.aspx) and download the
ShareScan6.1.zip file under Downloads > Installers. After that, download available
documentation under Downloads > Documentation.
• Device Registration Service 7.11: Log in to the eCopy Product Registration Portal (http://
registration.ecopy.com/login.aspx) and download the executable DRS v7.11 or later as well as
available documentation.

31
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Device Web Server (DWS) 5.8.1: Log in to the eCopy Product Registration Portal
(http://registration.ecopy.com/login.aspx) and download the client zip package
(DeviceWebServer_5.8.1.zip or later) as well as available documentation.
It is recommended to dedicate a folder on C or D drive to all of your downloads for quick and easy
access.

Install the eCopy ShareScan Server

Once you have verified that all prerequisites are met and all necessary downloads are available, you
can start deploying the package. Start by installing the eCopy ShareScan server. Follow the component
installation order described in this document.

Install eCopy ShareScan

DOUBLE-CHECK BEFORE YOU START: Before running the eCopy ShareScan installer, ensure that
you have the latest system updates on your machine and that Automatic Windows Updates are turned
OFF.
COMPLETE SETUP
1. Find the ShareScan6.1.exe file under the Install/ShareScan path in a digital copy of the eCopy
ShareScan installer.
2. Run ShareScan6.1.exe (right-click it and choose Run as administrator); the Choose setup
language screen is displayed. Select a preferred language (English by default) from the dropdown
list and click Next.
3. The Welcome screen is displayed. Click Next.
4. The installer displays the System Check screen.

If prompted, select the preferred option(s) from the dropdown list(s). Click Next. This screen displays
warnings on any possible issues that might have an impact on the proper operation of eCopy
ShareScan and provides information on how to resolve them. If relevant, it also enables you to
choose from more than one option such as the number of available network adapters for device-
Manager communication.
5. The Enter Product License Key screen is displayed. Provide your Product License Key (22
characters with dashes, or 18 without dashes; the system accepts either).
Note: Customer purchased licenses are provided to customers via their reseller channel upon
purchase. The software device license file received is immediately available for activation and use
within the software application.

32
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. Specify your location on the Choose Your Geographic Region screen. Click Next.
7. The End-User License Agreement (EULA) is displayed on the License Agreement screen. Accept
the EULA and click Next.
8. The Setup Type screen is displayed; select Complete.
• eCopy ShareScan configuration database is created on the installed SQL Server - eCopy
ShareScan 6.1 WebClient is installed (including the Apache Tomcat 8.5 server)
• An automatic full installation is performed of the following components:
• eCopy ShareScan 6.1 server
• OmniPage Capture SDK 20.1
• Microsoft SQL Server 2014 Express Local DB
• eCopy ShareScan configuration database is created on the installed SQL Server
• eCopy ShareScan 6.1 WebClient is installed including the Apache Tomcat 8.5 server. Default
eCopy ShareScan credentials (username / password) are used for database access, with SQL
server authentication
Note: Make sure the checkbox for Use the eCopy ShareScan default 'sa' password for
SQL Server installation is checked.

• The default installation path is C:\Program Files (x86)\Nuance\ShareScan6.1

9. The Installation Summary screen is displayed.

Click Install.
10.Click Finish when the InstallShield Wizard Completed screen appears.
11.Activate your license: Start the eCopy ShareScan Administration Console and click the Activate
license option. Launch the License Wizard and follow the instructions.
Note: eCopy ShareScan workflow display on Epson MFP requires logging and logout for the first
time (make sure to close the Administration Console while doing this).

12.Close the eCopy ShareScan Administration Console.

Note: Ensure that you do NOT start the eCopy ShareScan Administration Console.

CUSTOM SETUP
Note: A custom setup is recommended if you plan to share the database installed between multiple
Managers, such as for large-scale installations.

33
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. Make sure the following components are selected: eCopy ShareScan, eCopy ShareScan
configuration database, Microsoft SQL Server and eCopy ShareScan WebClient and click Next.

2. Click Next to install the components to the default installation folders.

Note: You can modify the installation path for each component, however it is recommended to
use the default path only.

Click Next to install the services with default service accounts credentials.

34
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Select Microsoft SQL Server 2014 SP2 Express database engine to install.
Note: Make sure you keep Use the eCopy default ‘sa’ password for SQL Server installation
checkbox as checked (not all connections and communications are performed with the default
credentials) and click Next.

4. Review the installation summary and click Install.

5. Upon successful completion of installation, click Finish to close the Installation Wizard.
6. Launch the eCopy ShareScan Administration Console and import the license file.
7. Close the eCopy ShareScan Administration Console.
Note: Ensure that you do NOT start the eCopy ShareScan Administration Console.

Install Device Web Service

DWS Installation
The standalone Device Web Server (DWS) manages and controls embedded applications on web-
based multi-function printers (MFPs).

35
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Ensure that the standalone DWS is installed on a different server than eCopy ShareScan.

1. Select the Installer file to launch the Setup Wizard. Right-click it and choose Run as administrator.
2. On the Welcome screen, click Next to begin the installation process.
3. Read and accept the terms of the Nuance End User License Agreement and click Next.
4. On the Destination Folder screen, accept the default installation folder or click Change to select a
new folder. Click Next.
5. Click Install, and then Finish to complete the installation.
6. Verify if DWS Service is running.

Install Device Registration Service

Quick Setup Process for eCopy ShareScan
DOUBLE-CHECK BEFORE YOU START: Administrative access to the server is required. All steps
outlined are performed from the server where the installation takes place. Close Administration
Console while using DRS.
Follow these steps to perform an installation of Nuance Unified Client for Epson v1.0 for an eCopy
ShareScan only environment:
1. Install DRS.
a) Download and unzip DeviceRegistrationService.zip. This creates a new folder
containing the DeviceRegistrationService.exe.
b) Run the DeviceRegistrationService.exe file, and follow the instructions to install DRS.
c) Start the service.
Note: Although you can deploy DRS to any server as long as there is no port conflict, a best practice
is to install the DRS wherever the Equitrac or eCopy ShareScan is installed. In this way, the DRS
server can control the same MFP devices that are controlled by the corresponding Equitrac server.
2. Enter http://<localAddressOrHostNameOrJustLocalhost>:9000/ in the web browser to
open the DRS web client interface.
3. Create an application in DRS (when creating an application, use the IP address):
a) Click the Applications tab.
b) Click the green ( ) button at the top left of the Applications pane.

c) In the Name field (required), enter an application name. For example, Epson.
d) In the Application Type field (required), select an application from the list.
e) In the DWS Server Address field (required), enter the DWS hostname or the IP address used by
the eCopy ShareScan Server.
f) In the Server configuration list (required), select eCopy ShareScan only.

36
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

g) In the eCopy ShareScan Server Address field (required), enter the IP address used by the
eCopy ShareScan Server. Use the IP address.
h) In the eCopy ShareScan Server Port field, enter the server port used by the eCopy ShareScan
Server.
i) In the eCopy ShareScan Server use SSL field, select True or False.
If you are uncertain which value to choose, navigate to the administrative web page of the device
and check the protocol (http: or https:) displayed on the address bar of the web browser.
j)
Click the Save button ( ) .
4. To add a device in DRS, do the following:
a) Click the Devices tab.

b) Click the green ( ) button at the top left of the Devices pane.
c) In the Name field (required), enter a name for the Epson device or device group that identifies it
on the network.
d) In the Address field (required), enter the IP address of the device.
e) In the Application field, select the application you have created from the list.
f) In the Device Group field, select the device group from the list.
g) In the Scan Destination field, enter the path of the shared folder where the scanned document is
placed (for example 12.34.56.78/localpath). NOTE: This folder is a DWS watch folder.
h) In the Scan Destination - User field, enter the administrator account name for the system.
i) In the Scan Destination - Password field, enter the administrator account password for the
system.
j) In the DWS Local Scan Path field, enter local file path used to create sub folders and maintain
the shared location (for example C:\localpath). NOTE: This file path must be the same as Scan
Destination folder.
Note: Scan Destination is a specific connection protocol share name of the watch folder
where MFP sends scanned files using Scan Destination - User and Scan Destination -
Password credentials. DWS looks for this same watch folder by monitoring DWS Local Scan
Path.
k)
Click the Save ( ) button.
5. After saving the device details, go to Details > Select Action... > Register Device with Server
Application and click Run Action icon ( ) to run the action. This may take a few moments to
complete; once finished, a Successfully completed message appears in the Action History pane
at the bottom of the screen.

37
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Set Up Your First Capture Workflow

eCopy ShareScan workflow display on Epson MFP requires additional changes on the DRS server upon
the first login.
Note: Ensure that you do NOT start the eCopy ShareScan Administration Console.

Note: On the MFP, log out in order to have the MFP registered in eCopy ShareScan.

1. Go to the Epson MFP and log in to Nuance Epson Launcher. Click Home button to go to Launcher.
The following message appears: "Connectors not configured for Device. Launch the Administration
Console and select connectors for this device".
2. Log out of Nuance Epson Launcher.
3. Start the eCopy ShareScan Administration Console.
4. Click the Devices panel. Your MFP is displayed in the Devices panel under a Device Group.
5. In Devices > Device Configuration > Device Groups select your Connectors and click Save.
6. Log in to Nuance Epson Launcher again and check whether your selected connectors appear at
Launcher.
Every additional device will be registered automatically to the device group created by the first device
and the configured connectors will appear on these devices.
At this point in the deployment workflow, you should already have a fully functioning installation along
with the activated license. To verify this, create and configure a simple capture workflow (Scan to File)
and test it on your device.

Configure and Publish Scan to File

Prerequisite: Before you configure the connector, you must create a folder on the desktop or at any
desired location on the eCopy ShareScan server machine and edit the permissions of the folder as
shared to Everyone.

38
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. Start the Administration Console and select the Connectors tab. The Configure connectors pane
displays a list of the installed connectors.
2. Select the Scan to File connector.
3. Go to the Destinations tab in the Configure Connectors area and click New. The Create a
destination window opens.

4. Type a name for the connector and select the type of scan destination folder as the Windows folder.
5. Provide a scan destination path (for example c:/scans).
Note: Make sure the scan destination folder has permissions as shared to Everyone.

6. Select Logon As from the Authenticate User list.

7. Provide the domain credentials of the user that is used to login on the eCopy ShareScan server.
8. Click OK to finish the configuration.
9. Save the currently configured connector as a new profile by clicking the Save current profile button.
The system saves your settings as part of the connector profile.
10.Select the device(s) listed under the Devices > Device Groups > Nuance Unified Clients in the
Device Configuration pane on the left side of the Administration Console.
11.Assign a Scan to File connector to the device by selecting the specific connector profile in the
Configure Connectors for Device.

39
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

12.Click Save You can save this configuration as the Default profile or as a new profile.
• To save as a new profile, enter a name for the profile and click Save.
• To modify an existing profile, select the profile from the list and proceed.

Use Scan to File

1. Login at the device as a domain user.
2. Tap on the Scan to File connector on the device screen.
3. Place a sheet that you wish to scan on the scanner glass. A preview of the paper is seen on the
screen, if enabled.
4. If preview is OK, tap Send. This pushes the scanned image to a shared location first (path of scan
destination that is defined at the time of DRS configuration) and then routes it to the shared folder
that was created while configuring the connector.
5. Verify that the scanned image is OK and tap Done on the device screen.

Appendix
Additional Documentation
For more information on how to perform an initial installation, configuration or upgrade of Device
Registration Service, see Device Registration Service Installation Guide provided with your product
software.
For more information on eCopy ShareScan, see the following documents provided with your product
software:
• eCopy ShareScan Administration Console Help
• eCopy ShareScan v6.1 Pre-installation Checklist for Epson Devices
• eCopy ShareScan v6.1 Installation Guide for Epson Devices.

Additional Requirements
Device Certificate requirements
The Device Certificate is imported or created on the device in order to support the HTTPS connection to
the device
A Transport Layer Security (TLS) certificate is used for the secure web communication between the
server and device.
If the device already has a TLS certificate, but has recently changed to another network, it is mandatory
to recreate the certificate to ensure that it matches the device’s hostname on the network.

DRS Settings Reference

This section describes options for the Nuance Unified Client for Epson v1.0 objects and documents
return and status codes.
Application Properties
These properties appear in the Device Registration Service Details pane of Applications when
you add or edit a Nuance Unified Client for Epson v1.0 Application profile. You cannot change the
application type for an existing Application profile.

Property Description

Name A name that uniquely identifies an Application.

40
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description

Application Type Select Epson Unified Client.

DWS Service Address Enter the IP address.

Server configuration Select the following server configuration: eCopy

ShareScan only.

Server configuration - eCopy ShareScan only The following properties are configured:
• eCopy ShareScan Server Address
• eCopy ShareScan Server Port
• eCopy ShareScan Server use SSL: Select
True or False.

Move from One DWS to Another

When moving a device from one DWS to another, make sure to update the Application property to point
to another DWS (in case other devices are added to the same DWS). The association of a device to
DWS is defined in the Application profile.
In case you want to change it from one DWS server to another, you must first perform the Deregister
Device from eCopy ShareScan Only action on all devices connecting to the old DWS1, before it is
changed to DWS2.
Make sure that the device is manually deleted from System Manager when deleting the device from a
DWS. In the case where DWS1 is down at the time when a delete is initiated, the device is still added to
DWS1 when the server comes back up (make sure to delete the device from DWS1 after that).
Devices Properties
On the Details toolbar, click the Edit button to edit the parameters for a Device profile. These
parameters define the Device settings. Click the Save button to save changes to the parameters or click
the Cancel button to discard changes.

Option Description

Name (required) The name of the Epson device or device group.

Address (required) The IP address of a Epson device.

Note: This is a Device profile-only
parameter and will not be displayed when
configuring parameters for a Device group.

Username The administrator account name for the Epson

device.

Password The administrator account password for the Epson

device. This field is empty by default.

41
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description

Application (required) A DRS Application profile with Nuance Unified

Client for Epson v1.0 as its Application Type.
When a Device is in a group, this property setting
is always inherited by the group and does not
appear for a Device.
Important: Before you edit an Application
profile for a previously registered device,
you should run the Uninstall and Deregister
Action before changing this setting.

Device Group When a Device profile is a member of a group

it can optionally inherit Device settings defined
for the group. This allows you to simultaneously
manage settings for multiple Device profiles.
Select the [Devices] option in this list to remove a
Device profile from group membership and move it
to the root folder in the Devices pane. This option
is not visible while you are configuring options for
a new Device profile.

Card Reader PID Card Reader Product ID (PID) of a USB card

reader.

Card Reader VID Card Reader Vendor ID (VID) of a USB card

reader.

Scan Destination This is the SMB path of the shared folder on the
system where DWS is running and the MFP sends
the scanned document.
For example: //10.56.59.42/Scandest.

Scan Destination - User The administrator account name for the system for
which the scan destination is defined.

Scan Destination - Password The administrator account password for the

system for which the scan destination is defined.

DWS Local Scan Path The local file path used to create sub folders and
maintain the shared location.

Actions Reference
To perform an action, first select a Device profile on the Devices tab in the Device Registration Service
web console. To perform an action on all Devices in a group, first select the group folder on the Device
tab. Then, in the box at the top of the Details pane, select one of the following actions from the list box
and click the run button.

42
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Action Description

Register Device with Server Application This Action first deregisters the client application
with the DWS, if it is already registered. Then it
registers the client application specified by the
Device profile with the DWS.

Deregister Device from Server Application Deregisters the client application from the DWS.

Return codes
The following table describes the return codes that can appear in the Device Registration Service
Action History pane for a Nuance Unified Client for Epson v1.0 Device or Device group.

Return Code Description

0 Successful Nuance Unified Client for Epson v1.0

registration.

1 Successful Nuance Unified Client for Epson v1.0

registration. Launcher icons setup is not supported
for this device type.

400 Failed to register device with DWS.

403 Access forbidden.

405 Device is busy. User is operating the panel.

500 Internal device error.

502 Device authentication failed.

503 Device is not reachable.

504 Device certificate mismatch.

505 DWS installation aborted due to licensing

restrictions.

506 DWS Installation has been canceled successfully.

507 DWS Installation procedure has not completed

yet. Checking prerequisites.

508 DWS server not reachable.

509 DWS authentication failed.

510 DWS installation failed.

511 Failed to process client package.

512 Device certificate invalid.

43
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Troubleshooting
Problem Solution

Install and Register Device with Server Application Run the Uninstall and Deregister Device with
Action fails. This is observed to occur after the Server Application Action on a Device before
Application setting is changed in the Device changing the Application setting.
settings and returns a DWS Installation
failed or and Internal device error
message.

Shortcuts to native device functions are not In order for shortcuts to native device functions to
available. show in the Equitrac UI workflow, the Epson Open
Platform (EOP) version must be manually set to
version 1.1. Go to the device Web Administrator
page > Epson Open Platform tab > Product key
and set the dropdown for Epson Open Platform
version to 1.1

Message "Communication error. Check the WI- Make sure that Scan Destination (DWS shared
FI/network connection" appears when the device folder) is defined in DRS under Devices > Details.
starts scanning.

Equitrac Deployment Guide

Equitrac Solution Overview
Version 1.0 of the Nuance Unified Client for Epson provides a unified client for capture and print
management functionality on specific Epson-manufactured Multi-Function Printers (MFPs). When
deployed to the MFP, Nuance Unified Client for Epson v1.0 controls access to the MFP, and acts as the
gateway for Nuance functionality.
Equitrac offers business users the flexibility to print what they need and when they need it, while
reducing the costs and complexities of deploying a print infrastructure. As user requirements for printing
change and IT infrastructure evolves, Equitrac lets businesses easily adapt to these changes with a
unique choice of how to deploy printing – using print servers, direct IP printing or a hybrid model that
includes both. This allows the creation of tailor-made print environments according to the specific needs
of users and businesses.
This document will walk you through a clean installation procedure in Equitrac Office/Express
standalone deployment. Also described is how to set up your first print workflow (Follow-You Printing) on
your Epson MFP device. If you want to go beyond these initial steps, ensure that you are consulting the
relevant Office/Express sections of the Equitrac product documentation.
To learn more, refer to Device Registration Service (DRS) and Equitrac documentation when performing
server-side configuration tasks.

Basic workflow
1. Prepare for deployment
a. Verify that your device is supported
b. Verify prerequisites

44
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

c. Get installer packages (Equitrac Office/Express 5.7 with the latest hotfixes and Device
Registration Service)
2. Install the Equitrac server
3. Configure the Epson MFP
4. Install and Set Up Device Registration Service (DRS)
a. Register the Epson device using DRS in Equitrac-only deployment
b. Verify that previous applications are cleared
c. Create application.
d. Add the device
e. Install and register
5. Configure your first workflow and verify installation
a. License Equitrac
b. Configure Follow-You Printing workflow

Prepare for Deployment

Verify that your device is supported
Nuance Unified Client for Epson v1.0 works on Epson MFPs that support the Epson Open Platform
(EOP) version 1.1.
For the latest list of supported Epson models, consult your local Epson representative or refer to
Nuance Supported Device Search webpage (https://nuanceimaging.custhelp.com/app/imaging/
supported_devices).

Verify prerequisites
DOUBLE-CHECK BEFORE YOU START: Before starting deployment ensure that the following
requirements are met. These are targeting a satisfying user experience when you are doing a single-
server installation.
Before installing Equitrac Office/Express ensure that the machine you plan to use meets the operating
requirements outlined below. Observe that you MUST have a 64-bit version of operating system.
Note: For Windows Servers 2008, 2008 R2, 2012, 2012 R2 and 2016, make sure the server is up
to date with the latest service packs, or manually download and install the latest version of Windows
Installer from Microsoft Home Official (https://www.microsoft.com/). Windows Installer 4.5 is required
to install Equitrac 5.7.

Check Description

Verify that the server machine is the member of a domain.

Ensure that the following hardware requirements are met:

• 8 GB of physical memory available
• 5 GB of hard disk space available (including 2 GB dedicated to DWS)
• The CPU is 4 x 2 GHz or greater

Ensure that you have Microsoft SQL Server 2008/2008 Express SP3 or later
installed.

45
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description

Verify that you have one of the following supported operating systems
installed: (IIS requirement (requires ASP.NET) is for the Web Client):
• Windows Server 2008 (x64 with IIS 7.0 and .NET 4.5)
• Windows Server 2008 R2 (x64 with IIS 7.5 and .NET 4.5)
• Windows Server 2012 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2012 R2 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2016 (x64 with IIS 10.0 and .NET 4.6)

Verify that you have Administrative access rights to Windows on the

server.

Check that all required Windows updates are installed.

Allow incoming firewall exceptions for the following ports:

• 80: Device port used for HTTP connections.
• 443: Device port used for HTTPS connections to the device.
• 587: SMTP Email server port used if TLS is enabled.
• 2939: SSL is always on for Equitrac and the default port setting of 2939
is not configurable in DRS.
• 8080: Redirects to port 8443 used for HTTPS communication to the
DWS.
• 8443: Each request to the DWS from the MFP uses the DWS address
as specified in DRS (TLS connections using port 8443). It is these
requests and events from the MFP to DWS that will request the DWS
server certificate when completing a TLS handshake. Also used by Web
Administration page.
• 8753: The default port for the Device Registration Service Web Service.
• 9000: The port used by the server to communicate with the web
client. This port is specified in the Service settings in the DRS Device
Configuration Manager.

Verify that Administrators are turned OFF under IE Enhanced Security

Configuration (to access this, go to Server Manager and then select Local
Server).

Check that you have all required installer packages downloaded and
within easy reach. For details, see Get Installer Packages section below.

Verify that you have Administrative access to the MFP device.

Note: Refer to the latest Equitrac Office/Express Technical Specifications document available from
the Equitrac Partner Portal (https://partners.equitrac.com/) for the most up-to-date information.

46
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Get installer packages

The following components are required for installing the Nuance Unified Client for Epson v1.0 software
in Equitrac Office/Express deployment:
• Equitrac Office/Express 5.7 (build 28.7293) or later with all available hotfixes installed: Log in to
the Equitrac Partner Portal (https://partners.equitrac.com/) and download the EO5.7a.zip /
EE5.7a.zip file under TECH SUPPORT > Software Downloads. Download all available fixes
under TECH SUPPORT > Hot Fixes. After that, download Equitrac Office/Express 5.7 related
documentation under TECH SUPPORT.
• Device Registration Service: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/)
and download the executable DRS v7.11 or later as well as available documentation under TECH
SUPPORT > Software Downloads > Device Registration Service (DRS).
It is recommended to dedicate a folder on C or D drive to all of your downloads for quick and easy
access.

Install Equitrac
This section provides the steps required to install Equitrac Office/Express on a single machine. A “Local”
installation places all Equitrac Office/Express server components and Administrative Applications on a
single machine. This type of installation is appropriate for small site deployment.
When installing Equitrac Office/Express, the installation wizard allows you to select the server
components and features to install per machine. For a local installation, install all server components
on the same machine. If you are installing all components on a single machine, you only need to run
the wizard once. When installing Equitrac Office/Express on a single machine, you can use either
the Simple install to obtain a default set of server components and features, or the Standard install
to customize the desired components and features to suit your environment. Both methods can be
modified after installation. For information on more complex scenarios, such as installing Equitrac
across multiple machines, refer to the Equitrac Office and Express Installation Guide available at the
Equitrac Partner Portal (https://partners.equitrac.com/).

Single machine installation

When installing Equitrac Office/Express, the installation wizard allows you to select the server
components and features to install per machine. For a local installation, install all server components
on the same machine. If you are installing all components on a single machine, you only need to run
the wizard once. When installing Equitrac Office/Express on a single machine, you can use either
the Simple install to obtain a default set of server components and features, or the Standard install
to customize the desired components and features to suit your environment. Both methods can be
modified after installation.

Install the Equitrac server

Once you have verified that all prerequisites are met and all necessary downloads are available, you
can start deploying the package.
To install Equitrac Office/Express on a single machine, do the following:
1. Close all other applications on the server prior to running the Equitrac Office/Express installation.
2. Unzip the downloaded EO5.7a.zip / EE5.7a.zip file.
3. Select and run the Installer file (Equitrac.Office.exe / Equitrac.Express.exe) to launch
the 64-bit Equitrac Office/Express Installation Wizard.
4. Read and accept the terms of the Nuance End User License Agreement, and click Install to
continue.

47
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. At the Welcome screen, click Next to begin the installation process.

6. On the Select language screen, choose the interface language and select Standard Install.
7. On the Select Features screen, expand Device Control Engine.
8. Select DWS, Scan Processing Engine and I-Queue components. Click Next.

9. (optional) Expand and select Device Control Service (DCS) if you are to use Ethernet Card
Readers.
10.On the Service Log On Credentials screen, enter the Account and Password of the user who
will run the Windows services. Alternatively, click Browse to search for valid user from a specific
location. Click Test Credentials to verify the user, and click Next to continue.

11.On the Windows Firewall Exceptions screen, select either a manual or automatic setup method
for the firewall exceptions. Click Next.
12.On the Database platform screen, select either the SQL Server or Oracle database, and click
Next.
• If SQL Server is selected (default selection), additional database location and authentication
information is required

48
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• If Oracle is selected, the Oracle client is automatically located by the installer and the wizard
advances without requiring any additional database information
13.If SQL Server is specified, select any available database server from the Database Instance list,
and then click Next. Alternatively, the database server address, and optionally the instance name,
can be typed in the Database Instance field.

14.On the Database credentials screen, select the authentication type of the selected SQL Server:
• Windows Authentication (default selection): select this option when the user running the
Windows Service account connects to the database server. This user was specified on the
Service Log On Credentials screen
• SQL Authentication: enter the user credentials in the Login and Password fields, (this can be
another Windows user or a SQL Server user)
15.Click Test Connection to check the connection to the database with the selected user, then click
Next.

49
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

16.If the specified SQL Express database (“eqcas”) already exists (for example, in the case of an
upgrade), the Database Already Exists screen appears. Select whether to Replace or Keep the
existing database, and click Next.
17.If any of the Web Client features are selected for installation, the Web Client - Application Pool
screens appears. Turn on the Application Pool and test it.
18.On the Web Client - Single Sign-On screen, select the Single Sign-On feature and click Next.
19.On the DCE High Availability Setup screen, do not select the DCE will be part of a High
Availability setup check box. Click Next.
20.On the DCE Local Cache Connection screen, enter the Administrator account and Password to use
with Distributed Cache, and click Next.

21.On the Ready to install Equitrac Office/Express screen, click Install.

22.Once installed, click Finish to exit the Installation Wizard.

Install Device Registration Service

Quick Setup Process for Equitrac
DOUBLE-CHECK BEFORE YOU START: Administrative access to the server is required. All steps
outlined are performed from the server where the installation takes place.
Follow these steps to perform an installation of Nuance Unified Client for Epson v1.0 for an Equitrac
only environment:
1. Install DRS.
a) Download and unzip DeviceRegistrationService.zip. This creates a new folder
containing the DeviceRegistrationService.exe.
b) Run the DeviceRegistrationService.exe file, and follow the instructions to install DRS.
Note: Although you can deploy DRS to any server as long as there is no port conflict, a best practice
is to install the DRS wherever the Equitrac is installed. In this way, the DRS server can control the
same MFP devices that are controlled by the corresponding Equitrac server.
2. Enter http://<localAddressOrHostNameOrJustLocalhost>:9000/ in the web browser to
open the DRS web client interface.

50
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Create an application in DRS (when creating an application, use the IP address):

a) Select the Applications tab.
b) Click the green ( ) button at the top left of the Applications pane.

c) In the Name field (required), enter an application name, for example Epson.
d) In the DWS Server Address field (required), enter the Equitrac DWS hostname or the IP
address.
e) In the Server Configurationlist, select Equitrac only.
Note: Each embedded device entry in System Manager must be associated with a
physical device (MFP). After Nuance Unified Client for Epson v1.0 is installed, your device
communicates with Equitrac specified during the installation and configuration via the DRS
component and an embedded device entry is automatically created in the Equitrac Office/
Express system, only if you applied the software license before installing the software on the
MFP.
f) In the DCE Server Address field (required), enter the IP address used by the Equitrac Server.
Note: DCE and DWS must have the same IP address.

g)
Click the Save button ( ).
4. Add a device in DRS:
a) Click the Devices tab.

b) Click the green ( ) button at the top left of the Devices pane.
c) In the Name field (required), enter a name for the Epson device or device group that identifies it
on the network.
d) In the Address field (required), enter the IP address of the device.
e) In the Application field, select the application you have created from the list.
f) In the Device Group field, select the device group from the list.
g) In the Card Reader PID field, enter the Card Reader Product ID (PID) of a USB card reader.

51
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

h) In the Card Reader VID field, enter the Card Reader Vendor ID (VID) of a USB card reader.
Note: Card Readers are only supported in Keyboard Emulation Mode. Use the
Nuance Reader Maintainer Tool available on the Equitrac Partner Portal (https://
partners.equitrac.com/) in the TECH SUPPORT > Software Downloads > Card Readers
section to set it to Keyboard Emulation Mode (the card reader is set to Proprietary Mode by
default).
i) In the Scan Destination field, enter the path of the shared folder where the scanned document is
placed (for example 12.34.56.78/localpath). NOTE: This folder is a DWS watch folder.
j) In the Scan Destination - User field, enter the administrator account name for the system.
k) In the Scan Destination - Password field, enter the administrator account password for the
system.
l) In the DWS Local Scan Path field, enter local file path used to create sub folders and maintain
the shared location (for example C:\localpath). NOTE: This file path must be the same as Scan
Destination folder.
Note: Scan Destination is a specific connection protocol share name of the watch folder
where MFP sends scanned files using Scan Destination - User and Scan Destination -
Password credentials. DWS looks for this same watch folder by monitoring DWS Local Scan
Path.
m)
Click the Save ( ) button.
5. After saving the device details, go to Details > Select Action... > Register Device with Server
Application and click Run Action icon ( ) to run the action. This may take a few moments to
complete; once finished, a Successfully completed message appears in the Action History pane
at the bottom of the screen

6. Locate the auto-added device and configure it in Equitrac System Manager.

Set Up Your First Print Workflow

At this point in the deployment workflow, you should already have a fully functioning installation. To
verify this, create and configure a simple print workflow (Follow-You Printing) and test it on your device.

Configuring Follow-You Printing

To configure Follow-You Printing settings, do the following:

52
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. In System Manager, go to Configuration > Printing > DRE/DRC and Follow-You Printing.
2. Select the Site where you want Follow-You Printing to be accessible from.
3. In the Settings section, select any of the following options:
• Cost the job before printing – sets the price to a print job based on its properties
• Reprice after release – changes the price of a print job if its properties change after it is released
• Hide document name in Windows print window – select this option if you do not want certain
documents (such as confidential) from being viewed in the general print queue
• Only print released job while user is logged in to device– if the user logs off prior to printing
the job, the job is put back into the print queue without being released, and the re-queued print
job is not charged to the user
4. In the Space management section, do the following:
a) Enter the Job expiry time. This is denoted in hours.
b) Enter the Print distribution job expiry time. This is denoted in hours.
5. Select Enabled or Disabled as the global Secure printing default for Follow-You Printing.
6. Select Retrieve username from PJL setting for applications that insert the PJL string into the print
job.
7. In the Number of ports per I-Queue field, enter the number of printer ports (up to 100) associated
with the devices used for I-Queue printing. This configures the number of ports assigned to the
Windows print queue and allows multiple print jobs to be processed at the same time.
8. Click OK to save the settings.
I-Queue Printing
I-Queue solves printing challenges by providing a single print queue for every user and every printer.
When submitting a print job you can setup and use the following printing mode options:
• The I-Queue printer for secure printing using a single Follow-You Printing queue where all printers
are combined into a single pull group. The I-Queue holds print jobs sent to the I-Queue printer from
a user workstation. This I-Queue method only supports secure printing and holds print jobs until the
user releases them at a networked printer via Follow-You Printing
• Direct printing via the I-Queue direct printer that enables you to print directly to a printer (without
printer driver installation and authentication or a Follow-You-Printing queue at a printer) in a simple
and straightforward method
• Both of the above methods
To deploy Nuance Unified Client for Epson v1.0 in a single-server or a multi-server Follow-You Printing
environment, do the following:
1. Enable secure printing on each device.
Secure printing sets up a virtual print queue that holds jobs until they are released at the embedded
device by a valid user.
2. Create and manage I-Queue (go to System Manager > Devices, right-click the Devices pane and
select Add I-Queue from the menu and define the settings in the I-Queue summary window).
3. Configure the Follow-You print settings.
Determine the site where you want Follow-You Printing to be accessible from, and choose whether
the print job is priced based on its properties before or after it is released.

53
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Use Follow-You Printing

1. Login at the device: Enter valid login credentials using the on-screen keyboard (invoked by tapping
within the User ID field), or by using a swipe card, or (optional) select the desired Quick Selection
option from the list on the screen, if available.
2. The Launcher screen appears.

Press the Follow-You Printing container from the displayed functions. The Follow-You Printing
screen displays all the queued documents associated with your login credentials or release key. By
default, the list displays documents in order from longest-queued to most-recently queued.
3. Select the job(s) that you want to print.
4. Press Print.

Available operations on the Follow-You Printing screen

• Select - or + to adjust the number of copies
• Select the Force B/W switch to force color jobs to print in black and white
• The top line of the documents list indicates the number of documents available. To select or deselect
all documents, press the checkbox next to Print Jobs
• Select or deselect individual print jobs by pressing the print job's respective selection checkbox
• Select Print to release all selected documents

The following options are available by selecting the menu icon at the top right of the screen:
• Select Delete to remove all selected documents from the Job List without printing them
• Select Print & Save to print and save all selected documents from the Job List
• Select Refresh to refresh the current page
• Select About to display the current version of Nuance Unified Client for Epson v1.0
• Select Logout to log out from Nuance Unified Client for Epson v1.0

Appendix
Additional Documentation
You may need to refer to one of the following documents when performing server-side configuration
tasks.
For more information on how to perform an initial installation, configuration or upgrade of Device
Registration Service, see Device Registration Service Installation Guide provided with your product
software.

54
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

For more information on Equitrac, see the following documents provided with your product software:
• Equitrac Office or Express Administration Guide
• Equitrac Office or Express Installation Guide

Additional Requirements
Device Certificate requirements
The Device Certificate is imported or created on the device in order to support the HTTPS connection to
the device
A Transport Layer Security (TLS) certificate is used for the secure web communication between the
server and device.
If the device already has a TLS certificate, but has recently changed to another network, it is mandatory
to recreate the certificate to ensure that it matches the device’s hostname on the network.

DRS Settings Reference

This section describes options for the Nuance Unified Client for Epson v1.0 objects and documents
return and status codes.
Application Properties
These properties appear in the Device Registration Service Details pane of Applications when
you add or edit a Nuance Unified Client for Epson v1.0 Application profile. You cannot change the
application type for an existing Application profile.

Property Description

Name A name that uniquely identifies an Application.

Application Type Select Epson Unified Client.

DWS Service Address Enter the IP address.

Server configuration Select the following server configuration: Equitrac

only

Server configuration - Equitrac only The following property is configured:

• DCE Server Address.

Move from One DWS to Another

When moving a device from one DWS to another, make sure to update the Application property to point
to another DWS (in case other devices are added to the same DWS). The association of a device to
DWS is defined in the Application profile.
In case you want to change it from one DWS server to another, you must first perform the Deregister
Device from Equitrac Only action on all devices connecting to the old DWS1, before it is changed to
DWS2.
Make sure that the device is manually deleted from System Manager when deleting the device from a
DWS. In the case where DWS1 is down at the time when a delete is initiated, the device is still added to
DWS1 when the server comes back up (make sure to delete the device from DWS1 after that).

55
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Devices Properties
On the Details toolbar, click the Edit button to edit the parameters for a Device profile. These
parameters define the Device settings. Click the Save button to save changes to the parameters or click
the Cancel button to discard changes.

Option Description

Name (required) The name of the Epson device or device group.

Address (required) The IP address of a Epson device.

Note: This is a Device profile-only
parameter and will not be displayed when
configuring parameters for a Device group.

Username The administrator account name for the Epson

device.

Password The administrator account password for the Epson

device. This field is empty by default.

Application (required) A DRS Application profile with Nuance Unified

Client for Epson v1.0 as its Application Type.
When a Device is in a group, this property setting
is always inherited by the group and does not
appear for a Device.
Important: Before you edit an Application
profile for a previously registered device,
you should run the Uninstall and Deregister
Action before changing this setting.

Device Group When a Device profile is a member of a group

it can optionally inherit Device settings defined
for the group. This allows you to simultaneously
manage settings for multiple Device profiles.
Select the [Devices] option in this list to remove a
Device profile from group membership and move it
to the root folder in the Devices pane. This option
is not visible while you are configuring options for
a new Device profile.

Card Reader PID Card Reader Product ID (PID) of a USB card

reader.

Card Reader VID Card Reader Vendor ID (VID) of a USB card

reader.

Scan Destination This is the SMB path of the shared folder on the
system where DWS is running and the MFP sends
the scanned document.
For example: //10.56.59.42/Scandest.

56
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description

Scan Destination - User The administrator account name for the system for
which the scan destination is defined.

Scan Destination - Password The administrator account password for the

system for which the scan destination is defined.

DWS Local Scan Path The local file path used to create sub folders and
maintain the shared location.

Actions Reference
To perform an action, first select a Device profile on the Devices tab in the Device Registration Service
web console. To perform an action on all Devices in a group, first select the group folder on the Device
tab. Then, in the box at the top of the Details pane, select one of the following actions from the list box
and click the run button.

Action Description

Register Device with Server Application This Action first deregisters the client application
with the DWS, if it is already registered. Then it
registers the client application specified by the
Device profile with the DWS.

Deregister Device from Server Application Deregisters the client application from the DWS.

Return codes
The following table describes the return codes that can appear in the Device Registration Service
Action History pane for a Nuance Unified Client for Epson v1.0 Device or Device group.

Return Code Description

0 Successful Nuance Unified Client for Epson v1.0

registration.

1 Successful Nuance Unified Client for Epson v1.0

registration. Launcher icons setup is not supported
for this device type.

400 Failed to register device with DWS.

403 Access forbidden.

405 Device is busy. User is operating the panel.

500 Internal device error.

502 Device authentication failed.

503 Device is not reachable.

504 Device certificate mismatch.

505 DWS installation aborted due to licensing

restrictions.

57
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return Code Description

506 DWS Installation has been canceled successfully.

507 DWS Installation procedure has not completed

yet. Checking prerequisites.

508 DWS server not reachable.

509 DWS authentication failed.

510 DWS installation failed.

511 Failed to process client package.

512 Device certificate invalid.

Troubleshooting
Problem Solution

Install and Register Action fails. This is observed Run the Uninstall and Deregister Action on a
to occur after the Application setting is changed Device before changing the Application setting.
in the Device settings and returns a DWS
Installation failed or and Internal
device error message.

Shortcuts to native device functions are not In order for shortcuts to native device functions to
available. show in the Equitrac UI workflow, the Epson Open
Platform (EOP) version must be manually set to
version 1.1. Go to the device Web Administrator
page > Epson Open Platform tab > Product key
and set the dropdown for Epson Open Platform
version to 1.1.

Message "Communication error. Check the WI- Make sure that Scan Destination (DWS shared
FI/network connection" appears when the device folder) is defined in DRS under Devices > Details.
starts scanning.

eCopy ShareScan and Equitrac Deployment Guide

eCopy ShareScan and Equitrac Solution Overview
Version 1.0 of the Nuance Unified Client for Epson v1.0 provides a unified client for capture and print
management functionality on specific Epson-manufactured Multi-Function Printers (MFPs). When
deployed to the MFP, Nuance Unified Client for Epson v1.0 controls access to the MFP, and acts as the
gateway for Nuance functionality.
Nuance eCopy ShareScan is a server-based solution designed to drive an increase in Office/Express
productivity while decreasing the environmental footprint through automation of paper-intensive
processes using Epson MFPs. eCopy ShareScan empowers workgroups and enterprises to capture the
data in paper documents easily and securely using Epson Open Platform (EOP) enabled MFPs.
Equitrac offers business users the flexibility to print what they need and when they need it, while
reducing the costs and complexities of deploying a print infrastructure. As user requirements for printing

58
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

change and IT infrastructure evolves, Equitrac lets businesses easily adapt to these changes with a
unique choice of how to deploy printing – using print servers, direct IP printing or a hybrid model that
includes both. This allows the creation of tailor-made print environments according to the specific needs
of users and businesses.
This document will walk you through a clean installation procedure in Equitrac Office/Express and
eCopy ShareScan deployment. Also described is how to set up your first scan capture workflow (Scan
to File) and print workflow (Follow-You Printing) on your Epson MFP device.
To learn more, refer to Device Registration Service (DRS) and eCopy ShareScan documentation when
performing server-side configuration tasks.

Basic workflow
1. Prepare for deployment
a. Verify that your device is supported
b. Verify prerequisites
c. Get installer packages (eCopy ShareScan Scan Server, Equitrac Office/Express 5.7 Prime Server
with the latest hotfixes, Device Registration Service)
2. Install the eCopy ShareScan server
3. Install the Equitrac server
4. Configure the Epson MFP
5. Install and Set Up Device Registration Service (DRS)
a. Register the Epson device using DRS in eCopy ShareScan-only deployment
b. Verify that previous applications are cleared
c. Create application.
d. Add the device
e. Install and register
6. Configure your first workflow and verify installation
a. License eCopy ShareScan and Equitrac Office/Express
b. Configure Scan to File workflow in eCopy ShareScan
c. Configure Follow-You Printing workflow in Equitrac Office/Express

Prepare for Deployment

Verify that your device is supported
Nuance Unified Client for Epson v1.0 works on Epson MFPs that support the Epson Open Platform
(EOP) version 1.1.
For the latest list of supported Epson models, consult your local Epson representative or refer to
Nuance Supported Device Search webpage (https://nuanceimaging.custhelp.com/app/imaging/
supported_devices).

Verify prerequisites
DOUBLE-CHECK BEFORE YOU START: Before starting deployment ensure that the following
requirements are met. These are targeting a satisfying user experience when you are doing a single-
server installation.
Before installing Equitrac Office/Express ensure that the machine you plan to use meets the operating
requirements outlined below. Observe that you MUST have a 64-bit version of operating system.

59
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: For Windows Servers 2008, 2008 R2, 2012, 2012 R2 and 2016, make sure the server is up
to date with the latest service packs, or manually download and install the latest version of Windows
Installer from Microsoft Home Official (https://www.microsoft.com/). Windows Installer 4.5 is required
to install Equitrac 5.7.

Check Description

Verify that the server machine is the member of a domain.

Ensure that the following hardware requirements are met:

• 8 GB of physical memory available
• 5 GB of hard disk space available (including 2 GB dedicated to DWS)
• The CPU is 4 x 2 GHz or greater

eCopy ShareScan: Ensure that the eCopy ShareScan install media

contains all the required dependency installer files under Install\ShareScan
\SetupPrerequisites\ in separate folders that must be installed to ensure
eCopy ShareScan functions properly. These are the following:
• Java SE Runtime Environment 8 Update 131 (x86) – version 8.0.1310.11
• Microsoft .NET Framework 4.6.2
• Microsoft Visual C++ 2012 Redistributable (x86) – version 11.0.61030
• Microsoft Visual C++ 2015 Redistributable (x86) – version 14.0.24123
• Microsoft Visual C++ 2015 Redistributable (x64) – version 14.0.24123
• Microsoft Visual J# 2.0 Redistributable

eCopy ShareScan: Check that database is SQL server 2008 or above,

express and non-express editions.

eCopy ShareScan: Check that the operating system is one of the following
64-bit ones:
• Windows Server 2008 R2 SP1 (64-bit support as a 32-bit application)
• Windows Server 2012 R2 (64-bit support as a 32-bit application)
• Windows Server 2016 (64-bit support as a 32-bit application)

eCopy ShareScan: Verify that Microsoft Windows Updates is turned

OFF. This is necessary for the successful installation of Microsoft Windows
Identity Foundation (TFS).

If you are planning to use any eCopy ShareScan Connector that requires
client software, ensure that this software is installed on your server
machine before starting deployment.

Check that Device Web Server (DWS) standalone is installed on a different

server than eCopy ShareScan.
Note: Under certain circumstances and scenarios (in case no other
web-based client or simulator is used), DWS and eCopy ShareScan can
reside on the same server.

60
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description

Ensure that you have Microsoft SQL Server 2008/2008 Express SP3 or later
installed.

Verify that you have one of the following supported operating systems
installed (IIS requirement (requires ASP.NET) is for the Web Client):
• Windows Server 2008 (x64 with IIS 7.0 and .NET 4.5)
• Windows Server 2008 R2 (x64 with IIS 7.5 and .NET 4.5)
• Windows Server 2012 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2012 R2 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2016 (x64 with IIS 10.0 and .NET 4.6)

Verify that you have Administrative access rights to Windows on the

server.

Check that all required Windows updates are installed.

Allow incoming firewall exceptions for the following ports:

• 80: Device port used for HTTP connections.
• 443: Device port used for HTTPS connections to the device.
• 587: SMTP Email server port used if TLS is enabled.
• 2939: SSL is always on for Equitrac and the default port setting of 2939
is not configurable in DRS.
• 8080: Redirects to port 8443 used for HTTPS communication to the
DWS.
• 8443: Each request to the DWS from the MFP uses the DWS address
as specified in DRS (TLS connections using port 8443). It is these
requests and events from the MFP to DWS that will request the DWS
server certificate when completing a TLS handshake. Also used by Web
Administration page.
• 8753: The default port for the Device Registration Service Web Service.
• 9000: The port used by the server to communicate with the web
client. This port is specified in the Service settings in the DRS Device
Configuration Manager.
• 9655/9656: Epson eCopy ShareScan SSL port is changed automatically
to 9656 when SSL is enabled and back to 9655 when SSL is false. The
default port is 9655.

Verify that Administrators are turned OFF under IE Enhanced Security

Configuration (to access this, go to Server Manager > then select Local
Server).

Check that you have all required components downloaded and within
easy reach.

Verify that you have Administrative access to the MFP device.

61
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Refer to the latest Equitrac Office/Express Technical Specifications document available from
the Equitrac Partner Portal (https://partners.equitrac.com/) for the most up-to-date information.

Get installer packages

The following components are required for installing the Nuance Unified Client for Epson v1.0 software
in Equitrac Office/Express and eCopy ShareScan deployment:
• eCopy ShareScan 6.1 or later with all available hotfixes installed: Log in to the eCopy
Product Registration Portal (http://registration.ecopy.com/login.aspx) and download the
ShareScan6.1.zip file under Downloads > Installers. After that, download available
documentation under Downloads > Documentation.
• Equitrac Office/Express 5.7 (build 28.7293) or later with all available hotfixes installed: Log in to
the Equitrac Partner Portal (https://partners.equitrac.com/) and download the EO5.7a.zip /
EE5.7a.zip file under TECH SUPPORT > Software Downloads. Download all available fixes
under TECH SUPPORT > Hot Fixes. After that, download Equitrac Office/Express 5.7 related
documentation under TECH SUPPORT.
• Device Registration Service: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/)
and download the executable DRS v7.11 or later as well as available documentation under TECH
SUPPORT > Software Downloads > Device Registration Service (DRS) .
It is recommended to dedicate a folder on C or D drive to all of your downloads for quick and easy
access.

Install the eCopy ShareScan Server

Once you have verified that all prerequisites are met and all necessary downloads are available, you
can start deploying the package. Start by installing the eCopy ShareScan server. Follow the component
installation order described in this document.

Install eCopy ShareScan

DOUBLE-CHECK BEFORE YOU START: Before running the eCopy ShareScan installer, ensure that
you have the latest system updates on your machine and that Automatic Windows Updates are turned
OFF.
COMPLETE SETUP
1. Find the ShareScan6.1.exe file under the Install/ShareScan path in a digital copy of the eCopy
ShareScan installer.
2. Run ShareScan6.1.exe (right-click it and choose Run as administrator); the Choose setup
language screen is displayed. Select a preferred language (English by default) from the dropdown
list and click Next.
3. The Welcome screen is displayed. Click Next.
4. The installer displays the System Check screen.

62
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

If prompted, select the preferred option(s) from the dropdown list(s). Click Next. This screen displays
warnings on any possible issues that might have an impact on the proper operation of eCopy
ShareScan and provides information on how to resolve them. If relevant, it also enables you to
choose from more than one option such as the number of available network adapters for device-
Manager communication.
5. The Enter Product License Key screen is displayed. Provide your Product License Key (22
characters with dashes, or 18 without dashes; the system accepts either).
Note: Customer purchased licenses are provided to customers via their reseller channel upon
purchase. The software device license file received is immediately available for activation and use
within the software application.
6. Specify your location on the Choose Your Geographic Region screen. Click Next.
7. The End-User License Agreement (EULA) is displayed on the License Agreement screen. Accept
the EULA and click Next.
8. The Setup Type screen is displayed; select Complete.
• eCopy ShareScan configuration database is created on the installed SQL Server - eCopy
ShareScan 6.1 WebClient is installed (including the Apache Tomcat 8.5 server)
• An automatic full installation is performed of the following components:
• eCopy ShareScan 6.1 server
• OmniPage Capture SDK 20.1
• Microsoft SQL Server 2014 Express Local DB
• eCopy ShareScan configuration database is created on the installed SQL Server
• eCopy ShareScan 6.1 WebClient is installed including the Apache Tomcat 8.5 server. Default
eCopy ShareScan credentials (username / password) are used for database access, with SQL
server authentication
Note: Make sure the checkbox for Use the eCopy ShareScan default 'sa' password for
SQL Server installation is checked.

• The default installation path is C:\Program Files (x86)\Nuance\ShareScan6.1

9. The Installation Summary screen is displayed.

63
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Click Install.
10.Click Finish when the InstallShield Wizard Completed screen appears.
11.Activate your license: Start the eCopy ShareScan Administration Console and click the Activate
license option. Launch the License Wizard and follow the instructions.
Note: eCopy ShareScan workflow display on Epson MFP requires logging and logout for the first
time (make sure to close the Administration Console while doing this).

12.Close the eCopy ShareScan Administration Console.

Note: Ensure that you do NOT start the eCopy ShareScan Administration Console.

CUSTOM SETUP
Note: A custom setup is recommended if you plan to share the database installed between multiple
Managers, such as for large-scale installations.

1. Make sure the following components are selected: eCopy ShareScan, eCopy ShareScan
configuration database, Microsoft SQL Server and eCopy ShareScan WebClient and click Next.

2. Click Next to install the components to the default installation folders.

64
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: You can modify the installation path for each component, however it is recommended to
use the default path only.

Click Next to install the services with default service accounts credentials.

3. Select Microsoft SQL Server 2014 SP2 Express database engine to install.
Note: Make sure you keep Use the eCopy default ‘sa’ password for SQL Server installation
checkbox as checked (not all connections and communications are performed with the default
credentials) and click Next.

65
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Review the installation summary and click Install.

5. Upon successful completion of installation, click Finish to close the Installation Wizard.
6. Launch the eCopy ShareScan Administration Console and import the license file.
7. Close the eCopy ShareScan Administration Console.
Note: Ensure that you do NOT start the eCopy ShareScan Administration Console.

Install Equitrac
This section provides the steps required to install Equitrac Office/Express on a single machine. A “Local”
installation places all Equitrac Office/Express server components and Administrative Applications on a
single machine. This type of installation is appropriate for small site deployment.
When installing Equitrac Office/Express, the installation wizard allows you to select the server
components and features to install per machine. For a local installation, install all server components
on the same machine. If you are installing all components on a single machine, you only need to run
the wizard once. When installing Equitrac Office/Express on a single machine, you can use either
the Simple install to obtain a default set of server components and features, or the Standard install
to customize the desired components and features to suit your environment. Both methods can be
modified after installation. For information on more complex scenarios, such as installing Equitrac
across multiple machines, refer to the Equitrac Office and Express Installation Guide available at the
Equitrac Partner Portal (https://partners.equitrac.com/).

Single machine installation

When installing Equitrac Office/Express, the installation wizard allows you to select the server
components and features to install per machine. For a local installation, install all server components
on the same machine. If you are installing all components on a single machine, you only need to run
the wizard once. When installing Equitrac Office/Express on a single machine, you can use either
the Simple install to obtain a default set of server components and features, or the Standard install
to customize the desired components and features to suit your environment. Both methods can be
modified after installation.

66
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Install the Equitrac server

Once you have verified that all prerequisites are met and all necessary downloads are available, you
can start deploying the package.
To install Equitrac Office/Express on a single machine, do the following:
1. Close all other applications on the server prior to running the Equitrac Office/Express installation.
2. Unzip the downloaded EO5.7a.zip / EE5.7a.zip file.
3. Select and run the Installer file (Equitrac.Office.exe / Equitrac.Express.exe) to launch
the 64-bit Equitrac Office/Express Installation Wizard.
4. Read and accept the terms of the Nuance End User License Agreement, and click Install to
continue.
5. At the Welcome screen, click Next to begin the installation process.
6. On the Select language screen, choose the interface language and select Standard Install.
7. On the Select Features screen, expand Device Control Engine.
8. Select DWS, Scan Processing Engine and I-Queue components. Click Next.

9. (optional) Expand and select Device Control Service (DCS) if you are to use Ethernet Card
Readers.
10.On the Service Log On Credentials screen, enter the Account and Password of the user who
will run the Windows services. Alternatively, click Browse to search for valid user from a specific
location. Click Test Credentials to verify the user, and click Next to continue.

67
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

11.On the Windows Firewall Exceptions screen, select either a manual or automatic setup method
for the firewall exceptions. Click Next.
12.On the Database platform screen, select either the SQL Server or Oracle database, and click
Next.
• If SQL Server is selected (default selection), additional database location and authentication
information is required
• If Oracle is selected, the Oracle client is automatically located by the installer and the wizard
advances without requiring any additional database information
13.If SQL Server is specified, select any available database server from the Database Instance list,
and then click Next. Alternatively, the database server address, and optionally the instance name,
can be typed in the Database Instance field.

14.On the Database credentials screen, select the authentication type of the selected SQL Server:
• Windows Authentication (default selection): select this option when the user running the
Windows Service account connects to the database server. This user was specified on the
Service Log On Credentials screen

68
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• SQL Authentication: enter the user credentials in the Login and Password fields, (this can be
another Windows user or a SQL Server user)
15.Click Test Connection to check the connection to the database with the selected user, then click
Next.

16.If the specified SQL Express database (“eqcas”) already exists (for example, in the case of an
upgrade), the Database Already Exists screen appears. Select whether to Replace or Keep the
existing database, and click Next.
17.If any of the Web Client features are selected for installation, the Web Client - Application Pool
screens appears. Turn on the Application Pool and test it.
18.On the Web Client - Single Sign-On screen, select the Single Sign-On feature and click Next.
19.On the DCE High Availability Setup screen, do not select the DCE will be part of a High
Availability setup check box. Click Next.
20.On the DCE Local Cache Connection screen, enter the Administrator account and Password to use
with Distributed Cache, and click Next.

69
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

21.On the Ready to install Equitrac Office/Express screen, click Install.

22.Once installed, click Finish to exit the Installation Wizard.

Install Device Registration Service

Quick Setup Process for eCopy ShareScan and Equitrac
DOUBLE-CHECK BEFORE YOU START: Administrative access to the server is required. All steps
outlined are performed from the server where the installation takes place. Close Administration
Console while using DRS.
Follow these steps to perform an installation of Nuance Unified Client for Epson v1.0 for eCopy
ShareScan and Equitrac environment:
1. Install DRS.
a) Download and unzip DeviceRegistrationService.zip. This creates a new folder
containing the DeviceRegistrationService.exe.
b) Run the DeviceRegistrationService.exe file, and follow the instructions to install DRS.
Note: Although you can deploy DRS to any server as long as there is no port conflict, a best practice
is to install the DRS wherever the Equitrac is installed. In this way, the DRS server can control the
same MFP devices that are controlled by the corresponding Equitrac server.
2. Enter http://<localAddressOrHostNameOrJustLocalhost>:9000/ in the web browser to
open the DRS web client interface.
3. Create an application in DRS:
a) Select the Applications tab.
b) Click the green ( ) button at the top left of the Applications pane.

70
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

c) In the Name field, enter an application name. For example, Epson.

d) In the DWS Server Address field (required), enter the Equitrac DWS hostname (this address can
be also used for multiple devices).
e) In the Server configuration list (required), select eCopy ShareScan and Equitrac.
f) In the eCopy ShareScan Server Address field (required), enter the IP address used by the
eCopy ShareScan Server.
g) In the eCopy ShareScan Server Port field, enter the server port used by the eCopy ShareScan
Server.
h) In the eCopy ShareScan Server use SSL field, select True or False.
If you are uncertain which value to choose, navigate to the administrative web page of the device
and check the protocol (http: or https:) displayed on the address bar of the web browser.
i) In the DCE Server Address field (required), enter the IP address used by the Equitrac Server.
Note: DCE and DWS must have the same IP address.

j)
Click the Save button ( ).
4. Add a device in DRS:
a) Click the Devices tab.

b) Click the green ( ) button at the top left of the Devices pane.
c) In the Name field (required), enter a name for the Epson device or device group that identifies it
on the network.

71
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

d) In the Address field (required), enter the IP address of the device.

e) Enter the Username and Password for the device. By default, the username is admin and the
password is left blank.
f) In the Application field (required), select the application you have created from the list.
g) In the Device Group field, select the device group from the list.
h) In the Card Reader PID field, enter the Card Reader Product ID (PID) of a USB card reader.
i) In the Card Reader VID field, enter the Card Reader Vendor ID (VID) of a USB card reader.
Note: Card Readers are only supported in Keyboard Emulation Mode. Use the
Nuance Reader Maintainer Tool available on the Equitrac Partner Portal (https://
partners.equitrac.com/) in the TECH SUPPORT > Software Downloads > Card Readers
section to set it to Keyboard Emulation Mode (the card reader is set to Proprietary Mode by
default).
j) In the Scan Destination field, enter the path of the shared folder where the scanned document is
placed (for example 12.34.56.78/localpath). NOTE: This folder is a DWS watch folder.
k) In the Scan Destination - User field, enter the administrator account name for the system.
l) In the Scan Destination - Password field, enter the administrator account password for the
system.
m) In the DWS Local Scan Path field, enter local file path used to create sub folders and maintain
the shared location (for example C:\localpath). NOTE: This file path must be the same as Scan
Destination folder.
Note: Scan Destination is a specific connection protocol share name of the watch folder
where MFP sends scanned files using Scan Destination - User and Scan Destination -
Password credentials. DWS looks for this same watch folder by monitoring DWS Local Scan
Path.
n)
Click the Save ( ) button.
5. After saving the device details, go to Details > Select Action... > Register Device with Server
Application and click Run Action icon ( ) to run the action. This may take a few moments to
complete; once finished, a Successfully completed message appears in the Action History pane
at the bottom of the screen.

6. Locate the auto-added Device and configure it in Equitrac System Manager. Besides configuring
Equitrac server, you can also add and configure Nuance Unified Client for Epson v1.0 component to
an eCopy ShareScan workflow.

72
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Set Up Your First Capture Workflow

eCopy ShareScan workflow display on Epson MFP requires additional changes on the DRS server upon
the first login.
Note: Ensure that you do NOT start the eCopy ShareScan Administration Console.

Note: On the MFP, log out in order to have the MFP registered in eCopy ShareScan.

1. Go to the Epson MFP and log in to Nuance Epson Launcher. Click Home button to go to Launcher.
The following message appears: "Connectors not configured for Device. Launch the Administration
Console and select connectors for this device".
2. Log out of Nuance Epson Launcher.
3. Start the eCopy ShareScan Administration Console.
4. Click the Devices panel. Your MFP is displayed in the Devices panel under a Device Group.
5. In Devices > Device Configuration > Device Groups select your Connectors and click Save.
6. Log in to Nuance Epson Launcher again and check whether your selected connectors appear at
Launcher.
Every additional device will be registered automatically to the device group created by the first device
and the configured connectors will appear on these devices.
At this point in the deployment workflow, you should already have a fully functioning installation along
with the activated license. To verify this, create and configure a simple capture workflow (Scan to File)
and test it on your device.

Configure and Publish Scan to File

Prerequisite: Before you configure the connector, you must create a folder on the desktop or at any
desired location on the eCopy ShareScan server machine and edit the permissions of the folder as
shared to Everyone.

1. Start the Administration Console and select the Connectors tab. The Configure connectors pane
displays a list of the installed connectors.
2. Select the Scan to File connector.
3. Go to the Destinations tab in the Configure Connectors area and click New. The Create a
destination window opens.

73
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Type a name for the connector and select the type of scan destination folder as the Windows folder.
5. Provide a scan destination path (for example c:/scans).
Note: Make sure the scan destination folder has permissions as shared to Everyone.

6. Select Logon As from the Authenticate User list.

7. Provide the domain credentials of the user that is used to login on the eCopy ShareScan server.
8. Click OK to finish the configuration.
9. Save the currently configured connector as a new profile by clicking the Save current profile button.
The system saves your settings as part of the connector profile.
10.Select the device(s) listed under the Devices > Device Groups > Nuance Unified Clients in the
Device Configuration pane on the left side of the Administration Console.
11.Assign a Scan to File connector to the device by selecting the specific connector profile in the
Configure Connectors for Device.
12.Click Save You can save this configuration as the Default profile or as a new profile.
• To save as a new profile, enter a name for the profile and click Save.
• To modify an existing profile, select the profile from the list and proceed.

Use Scan to File

1. Login at the device as a domain user.
2. Tap on the Scan to File connector on the device screen.
3. Place a sheet that you wish to scan on the scanner glass. A preview of the paper is seen on the
screen, if enabled.
4. If preview is OK, tap Send. This pushes the scanned image to a shared location first (path of scan
destination that is defined at the time of DRS configuration) and then routes it to the shared folder
that was created while configuring the connector.
5. Verify that the scanned image is OK and tap Done on the device screen.

Set Up Your First Print Workflow

At this point in the deployment workflow, you should already have a fully functioning installation. To
verify this, create and configure a simple print workflow (Follow-You Printing) and test it on your device.

74
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configuring Follow-You Printing

To configure Follow-You Printing settings, do the following:
1. In System Manager, go to Configuration > Printing > DRE/DRC and Follow-You Printing.
2. Select the Site where you want Follow-You Printing to be accessible from.
3. In the Settings section, select any of the following options:
• Cost the job before printing – sets the price to a print job based on its properties
• Reprice after release – changes the price of a print job if its properties change after it is released
• Hide document name in Windows print window – select this option if you do not want certain
documents (such as confidential) from being viewed in the general print queue
• Only print released job while user is logged in to device– if the user logs off prior to printing
the job, the job is put back into the print queue without being released, and the re-queued print
job is not charged to the user
4. In the Space management section, do the following:
a) Enter the Job expiry time. This is denoted in hours.
b) Enter the Print distribution job expiry time. This is denoted in hours.
5. Select Enabled or Disabled as the global Secure printing default for Follow-You Printing.
6. Select Retrieve username from PJL setting for applications that insert the PJL string into the print
job.
7. In the Number of ports per I-Queue field, enter the number of printer ports (up to 100) associated
with the devices used for I-Queue printing. This configures the number of ports assigned to the
Windows print queue and allows multiple print jobs to be processed at the same time.
8. Click OK to save the settings.
I-Queue Printing
I-Queue solves printing challenges by providing a single print queue for every user and every printer.
When submitting a print job you can setup and use the following printing mode options:
• The I-Queue printer for secure printing using a single Follow-You Printing queue where all printers
are combined into a single pull group. The I-Queue holds print jobs sent to the I-Queue printer from
a user workstation. This I-Queue method only supports secure printing and holds print jobs until the
user releases them at a networked printer via Follow-You Printing
• Direct printing via the I-Queue direct printer that enables you to print directly to a printer (without
printer driver installation and authentication or a Follow-You-Printing queue at a printer) in a simple
and straightforward method
• Both of the above methods
To deploy Nuance Unified Client for Epson v1.0 in a single-server or a multi-server Follow-You Printing
environment, do the following:
1. Enable secure printing on each device.
Secure printing sets up a virtual print queue that holds jobs until they are released at the embedded
device by a valid user.
2. Create and manage I-Queue (go to System Manager > Devices, right-click the Devices pane and
select Add I-Queue from the menu and define the settings in the I-Queue summary window).
3. Configure the Follow-You print settings.
Determine the site where you want Follow-You Printing to be accessible from, and choose whether
the print job is priced based on its properties before or after it is released.

75
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Use Follow-You Printing

1. Login at the device: Enter valid login credentials using the on-screen keyboard (invoked by tapping
within the User ID field), or by using a swipe card, or (optional) select the desired Quick Selection
option from the list on the screen, if available.
2. The Launcher screen appears.

Press the Follow-You Printing container from the displayed functions. The Follow-You Printing
screen displays all the queued documents associated with your login credentials or release key. By
default, the list displays documents in order from longest-queued to most-recently queued.
3. Select the job(s) that you want to print.
4. Press Print.

Available operations on the Follow-You Printing screen

• Select - or + to adjust the number of copies
• Select the Force B/W switch to force color jobs to print in black and white
• The top line of the documents list indicates the number of documents available. To select or deselect
all documents, press the checkbox next to Print Jobs
• Select or deselect individual print jobs by pressing the print job's respective selection checkbox
• Select Print to release all selected documents

The following options are available by selecting the menu icon at the top right of the screen:
• Select Delete to remove all selected documents from the Job List without printing them
• Select Print & Save to print and save all selected documents from the Job List
• Select Refresh to refresh the current page
• Select About to display the current version of Nuance Unified Client for Epson v1.0
• Select Logout to log out from Nuance Unified Client for Epson v1.0

Appendix
Additional Documentation
You may need to refer to one of the following documents when performing server-side configuration
tasks.
For more information on how to perform an initial installation, configuration or upgrade of Device
Registration Service, see Device Registration Service Installation Guide provided with your product
software.

76
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

For more information on eCopy ShareScan, see the following documents provided with your product
software:
• eCopy ShareScan Administration Console Help
• eCopy ShareScan v6.1 Pre-installation Checklist for Epson Devices
• Copy ShareScan v6.1 Installation Guide for Epson Devices
For more information on Equitrac, see the following documents provided with your product software:
• Equitrac Office or Express Administration Guide
• Equitrac Office or Express Installation Guide.

Additional Requirements
Device Certificate requirements
The Device Certificate is imported or created on the device in order to support the HTTPS connection to
the device
A Transport Layer Security (TLS) certificate is used for the secure web communication between the
server and device.
If the device already has a TLS certificate, but has recently changed to another network, it is mandatory
to recreate the certificate to ensure that it matches the device’s hostname on the network.

DRS Settings Reference

This section describes options for the Nuance Unified Client for Epson v1.0 objects and documents
return and status codes.
Application Properties
These properties appear in the Device Registration Service Details pane of Applications when
you add or edit a Nuance Unified Client for Epson v1.0 Application profile. You cannot change the
application type for an existing Application profile.

Property Description

Name A name that uniquely identifies an Application.

Application Type Select Epson Unified Client.

DWS Service Address Enter the IP address.

Server configuration Select between the following server configuration:

eCopy ShareScan and Equitrac.

Server configuration - eCopy ShareScan and The following properties are configured:
Equitrac
• eCopy ShareScan Server Address
• eCopy ShareScan Server Port
• eCopy ShareScan Server use SSL: Select
True or False
• DCE Server Address

77
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Move from One DWS to Another

When moving a device from one DWS to another, make sure to update the Application property to point
to another DWS (in case other devices are added to the same DWS). The association of a device to
DWS is defined in the Application profile.
In case you want to change it from one DWS server to another, you must first perform the Deregister
Device from Equitrac Only action on all devices connecting to the old DWS1, before it is changed to
DWS2.
Make sure that the device is manually deleted from System Manager when deleting the device from a
DWS. In the case where DWS1 is down at the time when a delete is initiated, the device is still added to
DWS1 when the server comes back up (make sure to delete the device from DWS1 after that).
Devices Properties
On the Details toolbar, click the Edit button to edit the parameters for a Device profile. These
parameters define the Device settings. Click the Save button to save changes to the parameters or click
the Cancel button to discard changes.

Option Description

Name (required) The name of the Epson device or device group.

Address (required) The IP address of a Epson device.

Note: This is a Device profile-only
parameter and will not be displayed when
configuring parameters for a Device group.

Username The administrator account name for the Epson

device.

Password The administrator account password for the Epson

device. This field is empty by default.

Application (required) A DRS Application profile with Nuance Unified

Client for Epson v1.0 as its Application Type.
When a Device is in a group, this property setting
is always inherited by the group and does not
appear for a Device.
Important: Before you edit an Application
profile for a previously registered device,
you should run the Uninstall and Deregister
Action before changing this setting.

78
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description

Device Group When a Device profile is a member of a group

it can optionally inherit Device settings defined
for the group. This allows you to simultaneously
manage settings for multiple Device profiles.
Select the [Devices] option in this list to remove a
Device profile from group membership and move it
to the root folder in the Devices pane. This option
is not visible while you are configuring options for
a new Device profile.

Card Reader PID Card Reader Product ID (PID) of a USB card

reader.

Card Reader VID Card Reader Vendor ID (VID) of a USB card

reader.

Scan Destination This is the SMB path of the shared folder on the
system where DWS is running and the MFP sends
the scanned document.
For example: //10.56.59.42/Scandest.

Scan Destination - User The administrator account name for the system for
which the scan destination is defined.

Scan Destination - Password The administrator account password for the

system for which the scan destination is defined.

DWS Local Scan Path The local file path used to create sub folders and
maintain the shared location.

Actions Reference
To perform an action, first select a Device profile on the Devices tab in the Device Registration Service
web console. To perform an action on all Devices in a group, first select the group folder on the Device
tab. Then, in the box at the top of the Details pane, select one of the following actions from the list box
and click the run button.

Action Description

Register Device with Server Application This Action first deregisters the client application
with the DWS, if it is already registered. Then it
registers the client application specified by the
Device profile with the DWS.

Deregister Device from Server Application Deregisters the client application from the DWS.

79
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return codes
The following table describes the return codes that can appear in the Device Registration Service
Action History pane for a Nuance Unified Client for Epson v1.0 Device or Device group.

Return Code Description

0 Successful Nuance Unified Client for Epson v1.0

registration.

1 Successful Nuance Unified Client for Epson v1.0

registration. Launcher icons setup is not supported
for this device type.

400 Failed to register device with DWS.

403 Access forbidden.

405 Device is busy. User is operating the panel.

500 Internal device error.

502 Device authentication failed.

503 Device is not reachable.

504 Device certificate mismatch.

505 DWS installation aborted due to licensing

restrictions.

506 DWS Installation has been canceled successfully.

507 DWS Installation procedure has not completed

yet. Checking prerequisites.

508 DWS server not reachable.

509 DWS authentication failed.

510 DWS installation failed.

511 Failed to process client package.

512 Device certificate invalid.

Troubleshooting
Problem Solution

Install and Register Action fails. This is observed Run the Uninstall and Deregister Action on a
to occur after the Application setting is changed Device before changing the Application setting.
in the Device settings and returns a DWS
Installation failed or and Internal
device error message.

80
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Problem Solution
Shortcuts to native device functions are not In order for shortcuts to native device functions to
available. show in the Equitrac UI workflow, the Epson Open
Platform (EOP) version must be manually set to
version 1.1. Go to the device Web Administrator
page > Epson Open Platform tab > Product key
and set the dropdown for Epson Open Platform
version to 1.1.

Message "Communication error. Check the WI- Make sure that Scan Destination (DWS shared
FI/network connection" appears when the device folder) is defined in DRS under Devices > Details.
starts scanning.

81
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Combined Client for

Konica Minolta Client Guide

Overview of the Nuance Combined Client for Konica Minolta

The Nuance Combined Client for Konica Minolta is a web-based client that merges AutoStore scan and
Equitrac and Output Manager print functionality on Konica Minolta iOption MFP devices. The Nuance
Combined Client for Konica Minolta has an authentication module and language interfaces for Danish,
Dutch, English, Finnish, French, German, Italian, Norwegian, Portuguese (Brazilian), Spanish (Latin
American), and Swedish.
When a user starts the Nuance Combined Client for Konica Minolta on a device, the client connects
to the Konica Minolta iOption component on AutoStore, the Konica Minolta CC embedded type on
Equitrac, or the KonicaMinolta embedded type on Output Manager. The embedded web server in
any of these cases uses the MFP device IP address to retrieve device configuration data from Device
Registration Service. This data determines how the Nuance Combined Client for Konica Minolta
behaves and how it contacts the AutoStore and Output Manager servers.
The following figure illustrates the architecture for a system that includes the Nuance Combined Client
for Konica Minolta:

82
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 2: System architecture with Nuance Combined Client for Konica Minolta

Implementation Checklist: Nuance Combined Client for Konica

Minolta
This topic displays a table of tasks required to implement the Nuance Combined Client for Konica
Minolta.
This checklist should evolve based on the experience you gain from performing deployments. You might
also want to perform custom checks that are based on a specific aspect of your network architecture or
environment.

Table 2: Nuance Combined Client for Konica Minolta Checklist

Check Description For more information, see

Confirm that your system meets • Requirements on page 85

requirements.

83
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description For more information, see

For AutoStore capture • Konica Minolta iOption

functionality, configure the component help in AutoStore
Konica Minolta iOption in an Process Designer.
AutoStore workflow using the
AutoStore Process Designer.

To use Equitrac as the Print • Equitrac Express

Manager, configure the Konica Administration Guide
Minolta CC embedded type on • Configure Equitrac on page
the Equitrac server. 93

To use Output Manager as the • Output Manager

Print Manager, configure the Administration Guide
KonicaMinolta embedded device
type in Output Manager.

Prepare the MFP 1: Configure • Configure Konica Minolta

Konica Minolta OpenAPI OpenAPI on page 86

Prepare the MFP 2: Configure • Configure MFP Auto Reset

MFP auto reset settings Settings on page 87

Prepare the MFP 3: Configure • Configuring a device to use

the MFP for print release the authentication application
on page 90

Prepare the MFP 4: Configure • Configuring a device to use

authentication on the MFP the authentication application
on page 90
• Configure to use SSL for Web
Services • Create a self-signed
• Configure WebDAV to use certificate in security tab on
SSL page 90
• Configure TCP to use SSL/ • How to configure a device to
TLS use SSL for Web Services
(OpenAPI) on page 90
• Configure WebDAV to use
SSL on page 91
• Configure TCP Socket
Setting to use SSL/TLS on
page 92

Add a DRS Application for • Add an Application

Nuance Combined Client for • Nuance Combined Client for
Konica Minolta Konica Minolta application
settings on page 141

84
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description For more information, see

Add or import a Nuance • Add a Device

Combined Client for Konica • Import a Device
Minolta Device profile

Register Nuance Combined • Nuance Unified Client for

Client for Konica Minolta Xerox Actions reference on
page 486

Requirements
The table in this topic details system requirements for the Nuance Combined Client for Konica Minolta.

Requirement Description
AutoStore The following are required if capture with
AutoStore is enabled in Device Registration
Service.
• Version 7.0 SP1
• Licensed for Konica Minolta iOption capture
component
• Task configured with the Konica Minolta iOption
capture component

Equitrac The following is required it print management with

Equitrac is enabled in Device Registration Service.
• Equitrac Office or Express 5.6
• Configure Konica Minolta CC embedded type

Output Manager The following is required it print management with

Output Manager is enabled in Device Registration
Service.
• Build 4.0 SP1
• OM Device configured with:
• Embedded client type set to KonicaMinolta
• Unified client option is selected
• OM Destination associated with the OM
Device with the correct printer family definition.
• Destination Group with Pending Queue.
• OM Source Output SEtting configured to
route to the Pending Queue.

Supported devices • Nuance Supported Device Search: Konica

Minolta

Hardware requirements • Device must have hard drive

85
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Requirement Description
Software requirements • OpenAPI ver 2.0 or later
• Web browser iOption kit is installed (LK101)

Before you set up and register the Nuance Combined Client for Konica Minolta in Device Registration
Service, configure the Konica Minolta OpenAPI on the device and configure the device to use the
authentication application.

Prepare the MFP to run the Nuance Combined Client for Konica
Minolta
Before you set up and register the Nuance Combined Client for Konica Minolta in Device Registration
Service, configure the Konica Minolta OpenAPI on the device and configure the device to use the
authentication application.

Configure Konica Minolta OpenAPI

1. Log on to the MFP with the Admin password if you are not already logged on.
2. Press Utility > Administrator Settings to display the following screen.

3. Press System Connection > OpenAPI Settings.

86
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Configure OpenAPI Settings.

Option Description
Access Setting Set this to Allow access to the device.
Port Number Port number that the device uses to
communicate with the print server.
Normally you can use the default setting of
50001 or 50003 for SSL.

SSL Set this depending on whether the device will

use an encrypted connection to communicate
with the print server. The default is setting Off.
Authentication Specifies whether the device will be configured
to authenticate users. The default is setting Off.

Configure MFP Auto Reset Settings

Auto reset settings described in this topic are required when registering Authentication to a Nuance
Combined Client for Konica Minolta device. If only the Application is registered without registering
Authentication, then we strongly recommend configuring these settings to improve user experience and
avoid scenarios where the client resets too quickly.
Note: The MFP administrator password is required to access the Administrator Settings menu.

1. Log on to the MFP with the Admin password if you are not already logged on.
2. Press Utility > Administrator Settings > System Settings > Reset Settings > System Auto
Reset.
3. Change System Auto Reset Time to 3 minutes.

87
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Press Utility > Administrator Settings > System Settings > Reset Settings > System Auto
Reset > Priority Mode.
5. Make a note of the Priority Mode setting used when the MFP resets.
The default setting is Copy.
6. Press Utility > Administrator Settings > System Settings > Reset Settings > Auto Reset.

88
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. Depending on the Priority Mode setting recorded in step 5 on page 88, change the value for the
appropriate function to 3 minutes:
Priority Mode setting Change value for this reset:
Main Menu or Copy Copy
Scan Scan/Fax
User Box User Box
Web Browser Web Browser

Configure MFP for Print Release

• Configure Print Without Authentication
On all MFPs, configure Print Without Authentication for color and black and white printing.
• Configure Page Scope Web Connection settings
On A4 devices, configure the following settings via Page Scope Web Connection.

Configure Print Without Authentication

On all MFPs, configure Print Without Authentication for color and black and white printing.
1. Log on to the MFP with the Admin password if you are not already logged on.
2. Go to Utility > Administrator Settings > User Authentication/Account Track > Print Without
Authentication.
3. Set the value for Print Without Authentication to Full Color/Black.

89
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configure Page Scope Web Connection settings

On A4 devices, configure the following settings via Page Scope Web Connection.
1. On the Security tab, choose ID & Print.
2. Set either ID and Print to Disable or set Public User to Print Immediately.

Configuring a device to use the authentication application

Complete the procedures in this section to configure a device for the Authentication Application.

How to configure a device to use SSL for Web Services (OpenAPI)

1. Create a self-signed certificate in security tab
2. Set up OpenAPI to use SSL
Create a self-signed certificate in security tab
1. Open a web browser and log on to the MFP as an administrator.
2. Click the Security tab and click SSL/TLS Setting.
The following page appears if the certificate is not installed:

3. Click Setting.
4. Select Create a self-signed certificate.
5. Click OK.

90
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. Specify certificate values and click OK.

Do not close the browser while the system generates the certificate.
7. Click OK.
8. If your browser indicates that the security certificate is not valid, accept the certificate to continue with
Set up OpenAPI to use SSL.
Set up OpenAPI to use SSL
1. Click the Network tab and click OpenAPI Setting.
2. Select Use SSL/TLS and click OK.
Note: This automatically uses port 50003.

3. Click OK.

Configure WebDAV to use SSL

1. Open a web browser and log on to the MFP as an administrator.
2. On the Network tab, select WebDAV Settings > WebDAV Server Settings.

91
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Select ON from the WebDAV Settings drop-down list.

4. Select SSL Only from the SSL Setting drop-down list and click OK.
5. Press OK.

Configure TCP Socket Setting to use SSL/TLS

1. Open a web browser and log on to the MFP as an administrator.
2. Click the Network tab and click TCP Socket Setting.

92
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Select Use SSL/TLS Port No.(SSL).

4. Click OK.

Configuring the Nuance Combined Client for Konica Minolta

Configure Equitrac
Configure the authentication for the Nuance Combined Client for Konica Minolta component to work with
Equitrac authentication.

Server side configuration

To enable Nuance Combined Client for Konica Minolta, you must add the Embedded device to the
available devices in System Manager, and initialize the device.
In order to do this, as a prerequisite, you must have:
• A Physical Device with a Print Queue
• Secure Document Release (SDR) must be enabled for the device.
Note: For information about adding physical devices and enabling SDR, please see the Equitrac
Express Administration Guide.

Configuring Secure Printing

Controlled Konica Minolta CC MFPs must use secure printing environment.
To configure a secure print environment, the print queue must be configured to hold print jobs.
1. In System Manager, navigate to Configuration > Devices >.

93
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Click on the Print queue you want to configure. You may need to expand the Physical device to see
the print queue.

Note: The print queue is created automatically the first time a user prints to the controlled device,
including when you print a test page upon configuration. If a print queue does not appear beneath
the Physical Device, send a print job to the MFP, then wait 30 seconds and refresh System
Manager.
3. In the Print queue summary dialog box, set the Secure printing option to Enabled from the Behavior
section, and click OK.

After completing these steps for each device, you need to configure the Konica Minolta CC embedded
device. See How to configure an embedded device on page 94.

How to configure an embedded device

You must create an embedded interface for each Konica Minolta CC MFP that will be controlled by
Equitrac Office and Express. The Equitrac System Manager component provides the tools to create
these interfaces.
Embedded devices are manufacturer-specific software components that handle the transfer of user
authentication and transaction details between these devices and your accounting server database.
Supported devices prompt users for valid user and account ID information for all print release, walk-up
copy, scan, and fax jobs.
1. Add the Nuance Combined Client for Konica Minolta device to the system.
2. Open System Manager and select Devices in the left pane. The device will appear in the Devices
list. Right-click on a Konica Minolta CC MFP physical device node in the right pane, then select Add
embedded device... from the menu.

94
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. The Embedded device window appears. Select Konica Minolta CC from the Type drop-down list.

4. Enter a Name and Description for the device. These are required fields, and cannot be left blank.
The content can be changed if necessary.
5. Select the Server hosting the DCE associated with this physical and embedded device from the
drop-down list. The Version field fills automatically.
Note: If you change the server associated with an embedded device that has already been
initialized by the Equitrac server, you must re-initialize the device.

6. Select the Card Reader HID decoding from the drop-down list. For details on HID decoding, see the
Equitrac Office and Express Administration Guide.

95
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. Click Pricing to configure pricing at the embedded device level. To configure the embedded device
to use the price list for that device, select the default price list. If you select an alternate price list for
the embedded device, the embedded device price list overrides the default price. For pricing details,
see Configuring Price Lists in the Equitrac Office and Express Administration Guide.
8. Click the link beside Tracked activities to override default tracking options for a particular embedded
device.
Note: If a device is using third-party scan tracking, then native scan tracking should not be used
because it results in duplicate counts. Opting out of native scan tracking also disables other native
scan options.
9. Click the Initialize button. This configures communication between this device and the Equitrac
server and returns to the Embedded device dialog box.
CAUTION: Clicking Initialize changes the configuration on the device itself and may require the
MFP to restart. Ensure that the MFP is not in use before you click Initialize. Click the Reboot
button on the MFP web configuration page to accomplish the restart remotely if necessary.

How to configure authentication prompts

The user authentication prompts on the MFP login screen are determined by your Equitrac Office and
Express configuration.
1. In System Manager, navigate to Configuration > Security and authentication > User
authentication.

96
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Select one of the following Authentication options from the Input type list box:
Option Description
Card swipe only Users authenticate with a swipe card.
Card swipe or keypad entry Users authenticate with a swipe card or at the
MFP front panel.
Keypad only Users authenticate at the MFP front panel.
3. Select one of the following options from the Secondary prompt list box:
Option Description
Always User must enter a secondary PIN if issued using
the soft keyboard.
If PIN2 available User must enter a secondary PIN if they have a
PIN 2 value associated with their user account.

97
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
If PIN2 available or keyboard login User must enter a secondary PIN if they have a
PIN 2 value associated with their user account,
or if they entered their primary PIN using the soft
keyboard.
Never Secondary PIN is not required. The Nuance
Combined Client for Konica Minolta allows the
user to log in by specifying a single PIN (primary
PIN or alternate primary PIN)
Only with keyboard login User must enter a secondary PIN using the
soft keyboard if issued after they entered their
primary PIN via the keyboard (rather than with
a swipe card). This option adds an extra layer
of security, preventing users without a card from
logging in without a secondary PIN.

Note: The Secondary PIN is not required if swipe card is used to log on to the embedded client.

4. In the Card setup area, enter the data start and stop positions in the Use data from position.
For details on entering HID decoding parameters, refer to the Using PageCounters chapter in the
Equitrac Express Administration Guide.
5. Select Auto-register primary PINs if you want users to register an unrecognized swipe card for
future use.
An External authority must be selected to allow card self-registration.
6. Click OK to save the change.
For more detailed user authentication options see Accounts System Configuration in the Equitrac
Express Administration Guide.
Login screens when Equitrac is the Print Manager
The Equitrac authentication settings affect the user login as shown here.
• Equitrac login without authentication (secondary PIN prompt not enabled on the server).

The scan and cancel buttons show in the dialog.

98
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Equitrac login with authentication (secondary PIN prompt not enabled on the server).

The scan and cancel buttons do not show in the dialog. The user only has access to
device functionality as determined by user permissions after entering the card ID and PIN.

99
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Equitrac login with authentication when card registration is enabled.

The PIN field is added below the Card ID field. The user only has access to device functionality as
determined by user permissions after entering the card ID and PIN.

100
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configure printer driver

The procedures in this section configure settings required to track printing through printer ports. When
DRE is set to track printing, it gathers details when the user prints. When a job is released, DRE
forwards these details to CAS based on the job characteristics determined by the port monitor.
How to configure device settings
1. Open System Manager and click Devices in the left pane.
2. In the right pane, click on the name of the physical device you want to configure for print tracking.
3. In the Settings section, select Track and record print transactions on this device in the Tracking
behavior list.

4. Click OK to save the changes.

5. Navigate to Configuration > Embedded devices.
6. Select Konica Minolta in the Device type drop-down list.
7. Click on the link beside Tracked activities to open the Embedded device configuration dialog box.

8. Ensure that the Print check box is not selected, and then click OK.
9. Click OK again to save the changes and close the Embedded device dialog box.
How to configure user authentication
1. In Windows, open the Printer window by clicking Start > Devices and Printers.
2. Right-click the Konica Minolta printer, and then click Properties to open the MFP properties window.

101
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Click the Configure tab, select User Authentication in the Device Option list.
4. In the Setting list, select Disable.

Note:

If the Setting box is disabled, click the Acquire Settings button, clear the Auto check box, and then
click OK. This activates the Setting box for the User Authentication option.
5. Click Apply to save the settings.
How to configure print authentication at the MFP
1. On the MFP console, press the Utility/Counter hard key.
2. Press Administrator Settings and log in as administrator.
3. Navigate to Administrator Settings > User Authentication /Account Track > Print without
Authentication, and select Allow to print without authentication.

102
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The Print without authentication option is used only when tracking print jobs through
Equitrac ports.

4. Press OK to save the setting.

How to configure card self-registration

When a user swipes an unregistered card, they are required to manually login in order to register the
card’s PIN. After the card registration a pop-up message appears with a logout button.
If you want users to self-register their swipe cards, you must enable this option in System Manager.
The User ID must already exist in CAS, or in the External authority defined to allow self-registration.
The Password comes from one of the defined external authorities. The information the user must enter
depends upon the authentication options that are set in System Manager. Two-level authentication is
required to register new cards, and the user must manually enter both primary and secondary login
credentials.
1. Open System Manager and navigate to Configuration > Security and authentication > User
authentication.

103
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. In the Authentication options section, do the following:

a) Open System Manager and navigate to Configuration > Security and authentication > User
authentication.
b) Select Card swipe only from the Input type list.
c) Select Always or Only with keyboard login from the Secondary prompt list.
The If pin available and If pin available or keyboard login options are not supported by Konica
Minolta devices.
d) Select the Auto-register primary PINs check box. Optionally, you can select the Register as
alternate PIN check box to record the PIN as the Alternate PIN instead of the Primary PIN.
3. Select one or more Authentication mechanisms supported by Konica Minolta CC:
• Equitrac Office/Express PINs – Select to connect an Equitrac print account with login
information.
• External user ID and password – Select to verify all user information outside of Equitrac.

104
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Equitrac Office/Express PIN with external password – Select if the user enters an Equitrac
PIN and the domain user account password. Equitrac cross-checks the database for the
corresponding Equitrac account name, then verifies the credentials against the selected external
authority for a network log on.
4. Click OK to save the changes and close the User authentication dialog box.
5. Navigate to Configuration > Security and authentication > External authentication and select an
External authority – Windows or LDAP. Refer to External User Authentication in the Equitrac Office/
Express Administration Guide for more details on setting up an external user authentication method.
After a user register their card, the user's account information is automatically associated with that card.
The user can next time swipe the card to log in automatically without manually entering a password.

How to configure billing codes for Nuance Combined Client for Konica Minolta devices
1. In System Manager, navigate to Configuration > User interaction > Session flow.

2. Select Prompt for billing code after user identification (at copiers) if you want the user to enter a
billing code immediately after authentication.
If the user has only one associated billing code, then the prompt is suppressed, and the billing code
is automatically applied to the job (valid for the copy and scan operations during the user session).
3. Select Prompt for billing code at job release (at copiers) if you want the user to enter a billing
code before they can release a print job.
If the user has only one associated billing code, then the prompt is suppressed, and the billing code
is automatically applied to the job (valid for a single job for the print operation).
4. Select the Billing code prompt details you want to display at the MFPs.
Option Description
Required field The user must enter a billing code. Users with
only one billing code are not prompted for a
billing code even if the Required field option
is selected. Instead, the embedded device acts

105
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
as if the user has entered one. If this option is
not selected, and the user does not have an
associated billing code, they can enter a "blank"
billing code to continue.
Search Adds a Search function where users can search
for billing codes.
Security mode Displays the Billing code in asterisk characters.
Show most recently used Does not apply to Konica Minolta CC embedded
devices.
Default to the previous billing code Does not apply to Konica Minolta CC embedded
devices.
5. Enter a name for the Billing code label on the MFP panel (for example, Billing Code).
6. Set the Billable option (Prompt for Billable and Billable label).
7. Configure Validate billing codes for CAS when it is available and/or unavailable (at workstations
only) in the respective fields.
8. Required: Set the Account balance option to a value other than Do not display.
Note: This configuration is required or the server will not send account balance information to the
Combined Client for Konica Minolta.

9. Click OK to save the settings.

How to configure a default billing code
Follow steps in this procedure to configure a default billing code for Nuance Combined Client for Konica
Minolta.
1. Create a price list for printing and scanning.
2. Assign this price list to the device and to the embedded client.
3. Create a billing code, create a user and set the default billing code as described above.
Note: Make sure the user and billing code have different balance.

4. In System Manager, navigate to Configuration > User interaction > Session flow, under Optional
display fields, set the Account balance to a value other than Do not display.
This provides the account balance information to the combined client.
5. Click OK to save the settings.

How to enforce color quotas

Konica Minolta CC can enforce limits on the number of color copies that any user can make, based on
their user account quota limits.
When configured to enforce color quotas, the Konica Minolta CC can disable the MFP when a user
exceeds their color copy limit. For a more detailed discussion about Color Quotas, see the Equitrac
Office/Equitrac Express Administration Guide.
Note: Nuance Print Manager server counts bi-color (or twin color) jobs as monochrome jobs.
However, this may not matter if a device counts twin color pages as full color pages and applies its
color rules.

106
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

To enable Nuance Combined Client for Konica Minolta to enforce color copy quota limits, do the
following:
1. Open System Manager and navigate to Configuration > Accounting and quotas > Color quota.

2. In the Color quota dialog, select Enable color quota.

3. Select Disable copying on color devices once quota exceeded.
This disallows black and white copying, and stops color copies if users exceed their color quota
limits. This enforces color copy to stop at:
• Start of session (if user does not have positive color quota at login)
• Never (not enforced)
4. Enter a Custom message to display to the user when they have exceeded their color quota.
If you do not do this, the color quota limit warning messages appear that describe the amount of
quota needed, the amount of quota available and the account(s) that were checked to confirm quota.
Note: This option is available only if escrow is enabled.

If the color quota limit warning message displays that the printing should be charged to:
• Delegator (delegated job): check the color quota of the delegator instead of the user.
• Both delegated and own jobs in the set: either
• Check the balance of the delegator and the user quota appropriately
• in the case there is not enough color quota to print, the warning message contains all related
accounts, their available quotas and quotas required.
After you dismiss the warning message, you are transferred back to the Follow-You Printing screen
where the same set of documents are selected as prior to your print attempt.
5. Click OK to save any changes.

Receiving Print Error Messages

On specific end-points, if you try to release a print job that costs more than the funds available in the
account, a message displays indicating that there are insufficient funds to release the document. If a
transaction with multiple documents fails due to insufficient funds, then a message displays indicating
the jobs have failed to print. The message does not list all the failed print jobs.

107
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Equitrac-only deployment configuration

Steps in this task must be completed for an Equitrac-only deployment with DRS.
The Nuance Device Control Service (DCS) handles communication between the embedded client
and the Equitrac server. The DCS supports communication between the client and the server when
AutoStore is not present. This allows Equitrac can interface with the embedded client when only
Equitrac functionality is required.
1. In a text editor (such as Windows Notepad) edit the Web.config to point to the DRS server:
• C:\Program Files\Equitrac\Version\Device Control Service
\KonicaPanelClient\Web.config
Where Version may be Office or Express.
2. In the Web.config folder, configure the following two settings depending on whether Equitrac or
DRS are installed on the same or different machines:

Equitrac and DRS installed on different

machines <add key="DrsServiceBaseUri"
value="http://host address:8753" />
<add key="DrsToolUri" value="http://host
address:9000" />

Equitrac and DRS installed on the same

machine <add key="DrsServiceBaseUri" value="http://
localhost:8753" />
<add key="DrsToolUri" value="http://
localhost:9000" />

3. The SSL settings for DCS are configured in the following file:
• C:\ProgramData\Nuance\DeviceControlService\Settings
\KonicaPanelClient.properties
The settings and default values in this file are:

Setting Default Description

usessl usessl=1 Specifies whether to use SSL.

port port=3348 The port number used by the

web application. The default is
3348. The certificate has to be
installed and associated with
this port.

certhash certhash= Thumbprint of certificate to bind

to port. If empty this defaults to
the thumbprint of the first valid
certificate in certstorename
with a subject equal to the fully
qualified host name.

certstorename certstorename=Equitrac- LocalMachine store containing

Shared the certificate to bind to port. If
this is empty, then the bind is
omitted.

108
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. In the DRS Application settings, leave AutoStore Server Address blank and configure the Print
Manager Address and Print Manager URI to point to the Equitrac server.
5. In the DRS Device settings, set Enable Scan to False and Enable Print Release to True.
6. Restart Equitrac DCS.
Related reference
Nuance Combined Client for Konica Minolta application settings on page 141
Nuance Combined Client for Konica Minolta device settings on page 144

Copy Stop
The Nuance Combined Client for Konica Minolta supports Copy Stop.
The following are required in Device Registration Service to use Copy Stop with Nuance Combined
Client for Konica Minolta.

Requirement See
User Counter Limit must be set to True in the Use Counter Limit
device settings.
Use Function Limit must be set to True in the Use Function Limit
device settings.
Authentication must be registered for a device. Register Authentication

When Copy Stop is enabled, a user with a zero balance can log onto the device. However the balance
will show as zero and the user will not be able to copy. The user will be able to see print jobs but unable
to release them.

Configure Output Manager

This procedure provides the high-level steps for configuring Output Manager server settings for the
Nuance Combined Client for Konica Minolta.
Complete the following procedure if the device Authentication property is set to OM Authentication or
OM Authentication with Device Access Control.
1. Start the Output Manager Console application and log in.
2. Configure SSL settings as described in Configure the SSL port.
3. Configure devices as described in Configure Output Manager devices.
4. Configure copy quota settings as described in Configure copy quota for users.
5. In user allowances profiles, set Copy balance type to Unlimited copying allowed.

Output Manager Authentication

The Konica Minolta iOption Unified Client provides an authentication service for Konica Minolta MFPs.
The service enables authentication through card readers and a touch screen. The credentials obtained
from the MFP are available to the Unified Client and other applications running on the device. You can
also apply access control by restricting specific users from features on the MFP.
Note: The PageScope Box Operator currently does not work when authentication is registered on an
MFP.

Card reader authentication with Output Manager

Most Konica Minolta MFPs support USB-attached card readers. Contact Konica Minolta Support to
determine which card readers are compatible with your MFP and if any firmware upgrades are required.

109
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

When the user authenticates through a card reader, the MFP sends the card ID to Output Manager. If
a match is found, the authentication service grants access based on the ACL configured for the user
for that MFP. The service also provides information about the user, such as the user name and email
address. If a match is not found, the MFP enables the user to associate the card to the user name.
Subsequent use of the card results in user authentication.
Use the Output Manager Console to configure card login settings. In the Administration application,
select Set General Preferences and select the Security tab. Click Help when the Security tab is active
for more information on configuring security settings.
During two-phase authentication, the user provides a Personal Identification Number (PIN) after swiping
a card. When you configure Output Manager to require two-phase authentication, the MFP prompts the
user for the PIN after swiping the card.
Output Manager touchscreen authentication
An end user can authenticate through the MFP touchscreen. If no user is logged on at the MFP, the
console shows the Nuance log on screen. Depending on the Output Manager configuration, the end
user can log in by entering a card ID, by entering a card ID and a PIN, or by entering a user name and
password.

Figure 3: Prompt to enter domain user name and password

110
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 4: Prompt to enter card ID

How to configure the SSL port

Follow the steps in this procedure to configure the Output Manager SSL port for the Nuance Combined
Client for Konica Minolta.
1. On the Output Manager server, click Start > All Programs > Output Manager Server > OM Server
Configuration to open the Output Manager Server Configuration Utility.
2. Click the SSL Certificate Manager tab and in the Output manager service ports box, select the
check box for the DdmInterface port.

111
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Click Help for more information on configuring SSL settings.

In the Applications settings in DRS, make sure that Use SSL for Web Application is set to True. See
Application Settings for details.

How to configure Output Manager devices

This topic describes how to configure devices in the Output Manager Console.
1. On the Output Manager server, select Start > All Programs > Output Manager > Output Manager
Console > Output Manager Console and connect to the Output Manager server.
2. In the Devices application, right-click the device and select Configure.
3. Click the Device Details tab.
4. For Embedded client type, verify that KonicaMinolta is selected.
5. Configure devices for accounting, and then complete the following steps:
a) Configure the device for external authentication.
b) Enable Output Manager login for Nuance Combined Client for Konica Minolta.
See How to configure login methods on page 116.
6. Configure devices for access control.
7. Configure devices for print preferences.
8. Configure devices for login methods.
9. Configure devices for billing accounts.
10.Configure user copy quotas for devices.

112
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure device for accounting

This procedure describes how to configure a device for accounting.
If the Device Configuration dialog box for the device is not open already, follow the instructions in
Configure Output Manager devices before continuing with this procedure.
Note: Accounting data for Output Manager print jobs and the Nuance Combined Client for Konica
Minolta scan jobs is always recorded, regardless of settings configured with this procedure.

1. In the Device Configuration dialog box, click the Device Details tab.
2. For Cost Management, select Prints or Copies depending on your business requirements.
3. If you selected Copies, specify the cost per page.
If the Nuance Combined Client for Konica Minolta is already started, restart it to implement the changes.
How to configure device for access control
This procedure shows how to create access control profiles for users, groups, and departments.
If Device Configuration dialog box for the device is not open already, follow instructions in How to
configure Output Manager devices on page 112 before continuing with this procedure.
Perform these steps only if access control is required.
Access control can be configured for users, groups, and departments. If access control is not
configured, a default profile with full access is provided for new users.
1. In the Device Configuration dialog box, click the Device Details tab.
2. Select Unified client.
3. In the Unified Client box, click Configure access control.
4. Click the appropriate tab to configure access control for Users, Groups, or Departments.
5. Click the browse button (...) for the user, group, or department that you want to configure.

113
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. In the Manage MFP ACL Profiles dialog box, you can create or edit ACL profiles for the selected
user, group, or department.
7. Click New to create an MFP ACL profile.

114
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

You do not need to restart the Nuance Combined Client for Konica Minolta to implement the
changes. The changes take effect the next time users log in to the Nuance Combined Client for
Konica Minolta.
How to configure device for print preferences
MFP Kiosk Preferences profiles make print preference available to users.
If Device Configuration dialog box for the device is not open already, follow instructions in Configure
Output Manager devices before continuing with this procedure.
Perform these steps only if you want users to adjust print preferences before printing.
1. In the Device Configuration dialog box, click the Device Details tab.
2. Select the Unified client check box.
3. In the Unified Client box, click New.
4. Type a name for the profile in the Name field.
5. Optional: Type a profile description in the Description field.
6. Click the arrow next to any item to expand an option group.
7. Select the check box next to a print option to add it to the Selected items list.

115
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

8. Click OK.
If the Nuance Combined Client for Konica Minolta is already started, restart it to implement the changes.
How to configure login methods
This procedure describes how to configure the sign-in methods for Output Manager users.
1. Start the Output Manager console and connect to the server.
To start the console, select Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application.
3. In the Administration options, click Set General Preferences.
4. In the Administration - Set General Preferences settings, click the Security tab.

116
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. Select options in the External client login section as described in the following table:

Option Description
Allow user name / password The user can log in by entering user name,
password, and selecting a domain.

Allow card swipe The user can log in through a card swipe. The
user must also enter a PIN if Require PIN with
card swipe is selected.

Allow manual card ID entry The user can log in by entering an ID. The
user must also enter a pin if Require PIN with
manual entry is also selected.

Allow unmasked card ID The card ID will be readable as it is entered.

If you clear this check box, the card ID will be
masked.

Default manual login method Select the default user login method:
• Card ID Entry
• User Name/Password

Require PIN with card swipe Users must also enter a pin when using a card
swipe.

Require PIN with card ID entry Users also enter a PIN when using manual card
ID entry.

6. Click Apply.

117
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. Restart Output Manager.

How to configure billing accounts
This procedure describes how to configure billing accounts and scan properties for Output Manager
users.
1. Start the Output Manager Console and connect to the server.
To start the console, click Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application.
3. In the Administration options, click Manage Billing Accounts.
4. In the Administration - Manage Billing Accounts settings, you can create or edit a billing list and
its billing accounts.

5. You can create secondary billing accounts under the main accounts.

The following steps associate the billing lists to users:

118
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. Click the Administration application again, and in the Administration options, click Manage Users.
7. In Administration - Manage Users, select a user and click the Device Profile column to select or
edit an existing profile or to create a new profile.

8. In a profile, you can create a single billing list, two billing lists, or one primary list and one secondary
list.

9. Click OK.
You do not need to restart the Nuance Combined Client for Konica Minolta. Users see the changes after
the next login.

119
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure copy quotas

This procedure describes how to configure the copy quota for a user.
1. Start the Output Manager Console and connect to the server.
To start the console, click Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application button.
3. In the Administration options, click Manage Users.
4. In the Administration - Manage Users pane, click the Balances tab.

5. For a user, select the check box in the Set Balance column, and click the browse button (...) in the
Allowances Profile column to create or edit profiles.

6. Click New or Edit to set allowances for print and copy.

120
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. Click OK to save changes to the profile and then click Close.

8. Click the profile list the Allowances Profile column to assign the allowances profile to the user.

You do not need to restart the Nuance Combined Client for Konica Minolta. Users see the changes after
the next login.
How to configure an Output Manager destination
DNS names should not be used for Nuance Output Manager destinations with Nuance Combined Client
for Konica Minolta devices.
For additional information about Nuance Output Manager destinations, refer to the help in Output
Manager.
1. In the Output Manager Devices list, right-click the device for the and click New Destination on the
shortcut menu.
This opens the Add Destination dialog box.
2. Choose the destination type in the Type list.
3. In the Server list, choose the Nuance Output Manager server.
4. In the Assign to group box, click a group or All Destinations.
5. Clear the Use DNS name if available box.
Important: This check box should always be cleared for any destination used for devices installed
with the Nuance Combined Client for Konica Minolta.

6. Click OK.

121
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Accounting
The Nuance Combined Client for Konica Minolta uses accounting flags to perform accounting
operations. Collecting accounting data is achieved through the following actions:
• Output Manager server tracks print activity.
• Output Manager server tracks AutoStore scan activity.
• Print and native copy activities are tracked according to the accounting flags. AutoStore scan
activities are also tracked.
The Nuance Combined Client for Konica Minolta records accounting data for color and black and white
content as follows:
• When a user logs in at a device, the Nuance Combined Client for Konica Minolta reads the device
print and copy counters. When the user logs out, the Nuance Combined Client for Konica Minolta
reads the counters and records the differences since the start of the session.
• The Nuance Combined Client for Konica Minolta records data for configured billing accounts. When
the user changes the billing accounts while logged in, the Nuance Combined Client for Konica
Minolta records the counter differences before each change.
• For an Output Manager print job, the Output Manager server records its accounting data at the end
of the job regardless of the accounting settings. The Output Manager server uses the recorded print
counters to reconcile the accounting data.
• For an AutoStore scan job, the Nuance Combined Client for Konica Minolta records its accounting
data at the end of the job regardless of the accounting settings.

Output Manager only deployment

context definition.
1. In the Application settings, set both AutoStore Server Address and the Print Manager Address
to the IP address of the Output Manager server.
2. Set Print Manager to Output Manager.
3. Configure Use SSL for Web Application to match whether SSL is configured for use on the Output
Manager server.
4. Configure Print Manager URI with the same server address and port number for both SSL and non-
SSL.
• http://local_IP_address:port_number
5. In the Device settings configure the following settings:
• Enable Scan: False
• Enable Print Release: True
• Default Functionality: Print Manager
Related reference
Nuance Combined Client for Konica Minolta application settings on page 141
Nuance Combined Client for Konica Minolta device settings on page 144

Copy balance type

The Output Manager copy balance type must allow unlimited copying to work with the Nuance
Combined Client for Konica Minolta.
The only Copy balance type currently supported for Nuance Combined Client for Konica Minolta is
Unlimited copying allowed. The client does not allow more than 20 copies to be printed for a job when
Copy balance type is set to any other value.

122
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

To configure this option, perform the following steps in Output Manager.

1. On the Output Manager server, click Start > All Programs > Output Manager > Output Manager
Console > Output Manager Console to open the Output Manager Console.
2. Click Administration > Manage Users.
3. On the Users tab, click the Balances tab.
4. For the user you want to configure, click the browse button (...) in the Allowances Profile column
5. In the Manage Allowances Profiles dialog box, click the profile (or Default) and click Edit (or New
to create a new profile).
6. In the Copy balance type box, click Unlimited copying allowed.

Configure AutoStore
Add the Konica Minolta iOption component to an AutoStore workflow to provide capture functionality
for Nuance Combined Client for Konica Minolta. When you create the DRS application, specify the
AutoStore server address as well as the port number specified on the Preferences tab of the AutoStore
component configuration.
For details about configuring the Konica Minolta iOption component in AutoStore, refer to the
component help in AutoStore Process Designer.

AutoStore authentication
AutoStore authentication is configured in the AutoStore Process Designer. After you add the Konica
Minolta iOption component to a workflow, you can configure authentication in the Konica Minolta iOption
component settings (on the Authentication tab of the Group Settings dialog box). For details, you can
refer to the help in the Konica Minolta iOption component settings dialog box.

123
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

For Windows authentication without DRS authentication registered, the following login screen is
displayed on the device.

With DRS authentication registered, the login looks the same as for Equitrac or Output Manager,
depending on which one is selected as the Print Manager application (on the Application field in the
DRS Device settings).
After the user logs in, the user sees can initiate an AutoStore workflow on the Start Workflow screen.

124
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

AutoStore only deployment

Steps in this task must be completed for an AutoStore-only deployment with DRS.
AutoStore supports capture functionality for a device. Captured documents are processed and routed
according to components configured in AutoStore workflows.
1. In the Application settings, use the default settings and only enter the AutoStore server IP address
for AutoStore Server Address.
2. In the Device settings, set print related settings to False and scan settings to True:
Option Set to
Enable Print Release False
Display destination specific documents only False
Enable Scan True

Related reference
Nuance Combined Client for Konica Minolta application settings on page 141
Nuance Combined Client for Konica Minolta device settings on page 144

Using the Nuance Combined Client for Konica Minolta

This section describes how to use the Nuance Combined Client for Konica Minolta.

125
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Combined Client for Konica Minolta login

This section describes how to configure login settings and how to log on to AutoStore, Equitrac, or
AutoStore through the Nuance Combined Client for Konica Minolta.

Output Manager login

This section describes how to configure login settings and how to log on to Output Manager through the
Nuance Combined Client for Konica Minolta.

Figure 5: Prompt to enter domain user name and password

126
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 6: Prompt to enter a card ID

AutoStore login
The Nuance Combined Client for Konica Minolta shows an AutoStore login screen when it is configured
to use the AutoStore login.
For Windows authentication without DRS authentication registered, the following login screen is
displayed on the device.

127
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

With DRS authentication registered, the login looks the same as for Equitrac or Output Manager,
depending on which one is selected as the Print Manager application (on the Application field in the
DRS Device settings).
After the user logs in, the user sees can initiate an AutoStore workflow on the Start Workflow screen.

128
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Equitrac login
This section shows Equitrac login screens for the Nuance Combined Client for Konica Minolta.
Equitrac login without authentication (secondary PIN prompt not enabled on the server).

The scan and cancel buttons show in the dialog.

129
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Equitrac login with authentication (secondary PIN prompt not enabled on the server).

The scan and cancel buttons do not show in the dialog. The user only has access to device
functionality as determined by user permissions after entering the card ID and PIN.

130
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Equitrac login with authentication when card registration is enabled.

The PIN field is added below the Card ID field. The user only has access to device functionality as
determined by user permissions after entering the card ID and PIN.

131
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to switch between capture and print

When both AutoStore and a Print Manager are configured in DRS, users can click from one to the other
in the Nuance Combined Client for Konica Minolta screen.
•
On the capture screen, click the button to switch to the print manager screen.

•
On the print manager screen, click the button to switch to the capture screen.

132
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to manage print jobs

Print jobs for both Equitrac and Output Manager are managed from the task list displayed by Nuance
Combined Client for Konica Minolta There are only small differences between the Follow-You Printing
and Secure Print screens.
• How to manage print jobs for Equitrac Follow-You Printing on page 133
• How to manage print jobs for Output Manager Secure Print on page 134

How to manage print jobs for Equitrac Follow-You Printing

• The Follow-You Printing screen allows users to manage pending and printed jobs when Equitrac is
the print manager. A user presses the check box for an item to select that job.

133
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press to
Print Prints selected jobs. This button is available
when one or more jobs are selected.
Print All Prints all jobs in the list. This button is available
when there are jobs in the list.
Delete Delete selected jobs. This button is available
when one or more jobs are selected.
Change Settings Change printer settings for selected jobs. This
button is available when one or more jobs are
selected. For more information, see How to
configure print settings on page 136.
Info View information about a job. This button is
available when one or more jobs are selected.
For more information, see How to view Print
Manager job information on page 138.
Switch to the capture screen.

Exit Nuance Combined Client for Konica Minolta.

How to manage print jobs for Output Manager Secure Print

• The Secure Print screen allows users to manage pending and printed jobs when Output Manager is
the print manager. A user presses the check box for an item to select that job.

134
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press to
Print Prints selected jobs. This button is available
when one or more jobs are selected.
Print All Prints all jobs in the list. This button is available
when there are jobs in the list.
Delete Delete selected jobs. This button is available
when one or more jobs are selected.
Change Settings Change printer settings for selected jobs. This
button is available when one or more jobs are
selected. For more information, see How to
configure print settings on page 136.
Info View information about a job. This button is
available when one or more jobs are selected.
For more information, see How to view Print
Manager job information on page 138.
Switch to the capture screen.

Exit Nuance Combined Client for Konica Minolta.

135
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure print settings

Print options are configured for both Equitrac and Output Manager on the Print Finishing Options
screen in Nuance Combined Client for Konica Minolta.
For both Equitrac and Output Manager, pressing the Change Settings button on the print job page
displays Print Finishing Options. There only small differences between these screens for the two print
manager applications.
• How to configure print settings for Equitrac Follow-You Printing on page 136
• How to configure print settings for Output Manager Secure Print on page 137

How to configure print settings for Equitrac Follow-You Printing

• Settings on this screen allow users to configure print settings for selected Equitrac print jobs.

Press To
Navigate to the capture screen.

Navigate back to the previous screen.

136
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press To
Navigate to the home screen.

Log out of the Nuance Combined Client for

Konica Minolta and return to the login screen.

Browse or edit setting.

Scroll previous options or values.

Scroll next options or values.

Done Save changes and close print finishing options.

How to configure print settings for Output Manager Secure Print

• Settings on this screen allow users to configure print settings for selected Output Manager print job.

137
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press To
Navigate to the capture screen.

Navigate back to the previous screen.

Navigate to the home screen.

Log out of the Nuance Combined Client for

Konica Minolta and return to the login screen.

Browse or edit setting.

Scroll previous options or values.

Scroll next options or values.

Done Save changes and close print finishing options.

How to view Print Manager job information

Job information is accessible both Equitrac and Output Manager jobs on the on the Document
Information screen in Nuance Combined Client for Konica Minolta.
For both Equitrac and Output Manager, pressing the View Info button on the print job page displays
Documentation Information screen. There only small differences between these screens for the two
print manager applications.
• How to view job information for Equitrac Follow-You Printing on page 138
• How to view job information for Output Manager Secure Print on page 139

How to view job information for Equitrac Follow-You Printing

• Settings on this screen allow users to view information for selected Equitrac print jobs. Users can
click the arrow keys to page between jobs.

138
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press To
Navigate to the capture screen.

Navigate back to the previous screen.

Navigate to the home screen.

Log out of the Nuance Combined Client for

Konica Minolta and return to the login screen.

Scroll to information about the previous job in the

job list.

Scroll to information about the next job in the job

list.

How to view job information for Output Manager Secure Print

• Settings on this screen allow users to view information for selected Output Manager print jobs. Users
can click the arrow keys to page between jobs.

139
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press To
Navigate to the capture screen.

Navigate back to the previous screen.

Navigate to the home screen.

Log out of the Nuance Combined Client for

Konica Minolta and return to the login screen.

Scroll to information about the previous job in the

job list.

Scroll to information about the next job in the job

list.

How to start an AutoStore workflow

The Start Workflow screen provides buttons that users can press to capture documents and start
AutoStore workflows in Nuance Combined Client for Konica Minolta.
The Nuance Combined Client for Konica Minolta Start Workflow screen allows users to select
workflows to capture, process, and route documents with Nuance AutoStore.

140
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press To
Navigate to the capture screen.

Log out of the Nuance Combined Client for

Konica Minolta and return to the login screen.

Scroll to previous forms.

Scroll to next forms.

Reference
This section describes options for the Nuance Combined Client for Konica Minolta objects and
documents return codes.
• Nuance Combined Client for Konica Minolta application settings on page 141
• Nuance Combined Client for Konica Minolta device settings on page 144
• Nuance Combined Client for Konica Minolta actions reference on page 148
• Return codes on page 149

Nuance Combined Client for Konica Minolta application settings

This table details Application options for the Nuance Combined Client for Konica Minolta. These options
may be viewed by clicking a Konica Minolta iOption Application profile on the Applications tab of the
Device Registration Service web application.

141
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description

Name A name to label the DRS application.

AutoStore The IP address, computer name, or DNS name of the machine that hosts AutoStore
Server Server. The default is the IP address for the local machine. You must specify an
Address address when using AutoStore or when using both AutoStore and a Print Manager.
Device actions use this address. If you do not specify this address and you enable
AutoStore Scan, error code 518 appears when you perform the Register Unified Client
action.

Print Specifies Equitrac or Output Manager as the print manager application.

Manager

Print The IP address of the machine that hosts the print manager server. The default is the
Manager local IP address. You must specify an address when Equitrac or Output Manager is
Address specified for Print Manager.
Device actions use this address if you do not enter an address for AutoStore Server
Address. If you do not specify this address and you enable Print Release, the
Register Unified Client action returns the error code 519.

Print The URI for the print manager server. The default URI is in the following format:
Manager
URI • Equitrac: https://local_IP_address:port_number/DwsMain/services
• Output Manager: http://local_IP_address:port_number
You must specify a value when Equitrac or Output Manager is specified for Print
Manager. The default port for Output Manager is 8068, and the default port for Equitrac
is 8443.
The URI is case sensitive, so you must specify the web folders on a server using the
same case as is used on the print manager web server. You can specify HTTP or
HTTPS protocols for Output Manager. If necessary, configure Output Manager for the
selected protocol.

142
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Web The port number used by the web application. The default is 3348.
Application
Port Verify that this port number matches the port number that you specified when
configuring AutoStore or the print manager:
• AutoStore only: Specify the port number configured in the Preferences settings for
the Konica Minolta iOption component in AutoStore Process Designer. The default
is 3348.
• AutoStore and print manager: Specify the port number configured for the
Konica Minolta iOption component in AutoStore Process Designer. If you
are using Equitrac as the print manager and Equitrac is installed on the
same server as AutoStore, you must configure Equitrac to use a different
port number or the Konica Minolta iOption component will fail to initialize
due to a port conflict. To change the port used by Equitrac, edit the port
setting in the KonicaPanelClient.properties file. The location for the
KonicaPanelClient.properties is here:
C:\ProgramData\Nuance\DeviceControlService\Settings
\KonicaPanelClient.properties
• Output Manager only: Specify the port number configured for Server port on the
Clients tab in the Set General Preferences settings of the Administration module
in Output Manager.
• Equitrac only: This setting should match the port setting in the
KonicaPanelClient.properties file. The default is 3348. In case of a
conflict with another application on the server, you can change the port setting
in the KonicaPanelClient.properties file to specify an unused port
and configure the value here to match the new setting. The location for the
KonicaPanelClient.properties is here: C:\ProgramData\Nuance
\DeviceControlService\Settings\KonicaPanelClient.properties
For more information about configuring settings used by the DCS Service, see Equitrac-
only deployment configuration on page 108.
If you are using AutoStore and this port setting does not match the port setting for
the Konica Minolta iOption component, a Connection error message appears on
the device panel when a user presses the application button. If you use using a print
manager only (either Equitrac or Output Manager) and this port does not match the port
setting configured for the print manager application, a Connection error message
appears on the device panel when a user presses the application button.

143
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Use SSL Select True to enable the secure socket layer (SSL) for the web application. The default
for Web is False.
Application
• AutoStore: If this value does not match the Use SSL setting specified for the
AutoStore Konica Minolta iOption component on the Preferences, a Connection
error message appears on the device panel when a user presses the application
button.
• Equitrac: If you use Equitrac only and Enable SSL Transfer is not selected in the
device connection settings, a Connection error message appears on the device
panel when a user presses the application button.
• Output Manager: If you use Output Manager only and this value does not match
the Use SSL setting on the Clients tab of the Set General Preferences settings in
the Administration Module of Output Manager, Connection error appears on the
device panel when a user presses the application button.

Application The Konica Minolta OpenAPI port number for the Nuance Combined Client for Konica
OpenAPI Minolta. The default is 13351.
Port
This port number is used to run the embedded KM Konica Minolta OpenAPI server for a
web application.

Authority The Konica Minolta OpenAPI port number for the Authority application. The default is
OpenAPI 13353.
Port
This port number is used to run the embedded Konica Minolta OpenAPI Server for an
authentication application.

Nuance Combined Client for Konica Minolta device settings

This table details Device profile options for the Nuance Combined Client for Konica Minolta. These
options may be viewed by clicking a Konica Minolta iOption device on the Devices tab of the Device
Registration Service web application.

Property Description

Name A name to label the DRS device.

Address Specifies the IP address for the device.

Username Specifies the user name for administrative log on

to the device.

Password Specifies the password that corresponds to the

specified user name.

Application Specifies the DRS application to be used with this

device.

144
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Device Group Specifies membership in a device group.

Default Functionality Determines the default functionality for the client:

AutoStore The AutoStore page

appears when a user
presses the application
button on the device
panel.
Print Manager The Print Release
page appears when
a user presses the
application button on
the device panel.

Enable Print Release Enables the print manager functionality for this
device. The default value is False.

Display destination specific documents only Enables the user to see only printing jobs that are
associated with a specific destination or with a
group of destinations. The default value is False.
This setting is not available when Equitrac is the
Print Manager.

Enable Scan Enables AutoStore scan functionality for this

device. The default value is True.

Application Name The application name that appears on the device

panel.

Open API Login Name The login name for the Open API authentication
layer. This setting is required if you use the
OpenAPI authentication layer on the device.
To use the OpenAPI authentication layer on a
device, turn on OpenAPI authentication and
configure a user name and password. The login
name specified here must then match the user
name specified for the OpenAPI settings on the
device.

145
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Open API Password The password for the Open API authentication
layer. This setting is only required if you use the
OpenAPI authentication layer on the device.
To use the OpenAPI authentication layer on a
device, OpenAPI authentication needs to be
turned on and you must configure a user name
and password . The password specified here
must then match the password specified for the
OpenAPI settings on the device.

Use Counter Limit Enables the counter limit for a device. This option
prevents users from copying pages after the limit
is reached. Separate limits may be configured
for color and monochrome jobs. Bi-color jobs are
counted as monochrome. The device displays a
message if the native copy application is launched
after a limit has been exceeded.
Note: The Print Manager counts bi-color
(or twin color) jobs as monochrome jobs.
This may be ignored it a device counts twin
color pages as full color pages and applies
its color rules.

Copy Stop requires that Authentication be

registered and that Use Counter Limit and Use
Function Limit both be set to True in the DRS
device profile.

Use Function Limit Setting this option to True enables you to restrict
available functions by user or account. For
example, you can set it up so that specific users
or accounts can use the copy function but not fax,
while other users or accounts can fax but not copy.
Copy Stop requires that Authentication be
registered and that Use Counter Limit and Use
Function Limit both be set to True in the DRS
device profile.

146
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Device Landing Page This setting determines how the device is
presented to the user when authentication is
registered.

Option Description

None After user

authentication, the
device will appear on
the Menu page.

Native Scan After user

authentication, the
device will come
up in its own scan
application.

Native Copy After user

authentication, the
device will come
up in its own copy
application.

Nuance Combined After user

Client authentication, the
device will appear in
the Nuance Combined
Client for Konica
Minolta.

Important: After you change this setting,

you must restart the Nuance Device
Registration Service and the Print Server
(Output Manager or Equitrac) for the
change to be visible on a client device. For
information about restarting the Nuance
Device Registration Service, see How to
manage the DRS service on the server on
page 23.

147
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Display Balance Set this option to True to display the Equitrac
account balance for copying on the device panel.
The default setting for this option is False. This
setting is always available but only applies when
Equitrac is used for the Print Server.
Note: When Equitrac is used for the Print
Server, the Equitrac Configuration setting
Session Flow > Optional Display Fields >
Account balance option must always be set
to a value other than Do not display, or the
server will not transmit balance information
to the Combined Client for Konica Minolta.
For more information, see How to configure
billing codes for Nuance Combined Client for
Konica Minolta devices on page 105.

Nuance Combined Client for Konica Minolta actions reference

Actions that can be performed from the Device Registration Service for a Konica Minolta iOption device.
To perform an action, select a Device profile on the Device tab in the Device Registration Service
web console. Select an action from the Select Action drop-down list in the Details section and click
Perform selected.

Action Description

Register Unified Client Registers the Nuance Combined Client for

Konica Minolta on the device. A button with the
application name is added to the APP section on
the device.
Note: Devices are registered while the
server is running, so there is no need
to restart the server after adding and
registering new devices.

Unregister Unified Client Unregisters the Nuance Combined Client for

Konica Minolta on the device. The button with the
application name is removed from the application
software section on the device.

Register Authentication Registers authentication on the device. After

you register authentication, the authentication
application controls access to the device. Users
cannot view the device menus and the application
software section until authentication is complete.

148
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Action Description
Unregister Authentication Unregisters authentication on the device. After you
unregister authentication, the device shows the
normal menu screen.

Return codes
The following table describes the return codes that can appear in the Device Registration Service
Action History pane for a Konica Minolta iOption device or device group.

Return Code Description

101 Successful Nuance Combined Client for Konica

Minolta registration.

102 Successful authentication registration.

104 Successful Nuance Combined Client for Konica

Minolta unregistration.

105 Successful authentication unregistration.

301 Device is offline.

302 Device is online.

303 Device is online and one of three applications is

registered.

304 Device is online and two of three applications are

registered.

305 Device is online and all three applications are

registered.

500 Konica Minolta iOption device registration failed.

501 Konica Minolta iOption device unregistration failed.

502 Unable to proceed. Please restart device.

503 Invalid password. Please retry login.

504 Unable to connect to device. Please restart

device.

505 Maximum registered applications exceeded.

Remove unused applications and retry.

149
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return Code Description

506 Device is locked. Retry later.

507 Logo icon file does not exist. Please contact

Nuance Communications Support.

508 The device solution key file not found. Please

contact Nuance Communications Support.

509 Invalid Output Manager server address. Enter

correct server address and retry.

510 Registration was unsuccessful on the device.

511 Device does not support iOption. Add iOption or

use the Native Scan connector.

512 Invalid password. Enter the valid password and

retry.

513 Unregistration failed because Konica Minolta

iOption device is not registered.

515 OpenAPI SSL is not enabled on the device.

Authority registration requires OpenAPI SSL.
See Device Registration Service Help to enable
OpenAPI SSL.

517 Registration failed due to insufficient device

memory.

518 Invalid AutoStore server address. Enter the valid

address and retry.

519 Invalid web application port number. Enter the

valid port number and retry.

520 The device did not respond in time. Please verify

that the device is powered up, connected and not
in deep sleep mode.

150
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Restrictions and Limitations for the Nuance Combined Client

for Konica Minolta
This page lists restrictions and limitations for the Nuance Combined Client for Konica Minolta combined
client.
• The DRS landing page does not work on some A4 devices due to a limitation of the MFP. There is
currently no work-around for this.
• On a C652 device, there is a restriction on entry into numeric fields in AutoStore forms. In an
AutoStore form displayed by the Nuance Combined Client for Konica Minolta, you can only enter
numbers using buttons on the device panel screen. You cannot enter numbers with the built-in
numeric keypad or an attached keyboard.
Note: In native device forms, you can enter numbers with buttons on the screen or using the built-
in numeric keypad on the MFP, but not with an attached keyboard.

• When then MFP is configured such that no password is required to enter Administrator mode, an
attempt to delete the AutoStore Konica Minolta MFP client from the application list will fail. This
occurs because a password is required to delete the application. The deletion may be performed
successfully by first configuring the MFP to require a password to enter Administrator mode.
• The Account balance option in the Equitrac Session flow options must be set to a value other than
Do not display. This is required for the server to send account balance information to the Combined
Client for Konica Minolta. For more information, see How to configure billing codes for Nuance
Combined Client for Konica Minolta devices on page 105.
• Enforcing account limits for scans is not supported.

Troubleshooting
• Authentication connection errors on page 151
• Unified Client application connection errors on page 152
• Unified Client resets too quickly on page 153
• Unified client registration error messages on page 154
• Authentication registration error messages on page 155
• Unified Client unregistration error messages on page 156
• Orphan Unified Client button on the device on page 157
• Landing page not visible after changing Device Landing Page device setting on page 158
• Device panel blocks usage during session on page 158
• Incorrect balance displayed for Equitrac copy jobs on page 158

Authentication connection errors

Follow these steps to resolve an authentication connection error on a device:
• Verify that the AutoStore and Output Manager servers are started.
• Verify that the port specified in the application settings for a device in the Device Registration Service
matches the port specified in AutoStore or Output Manager:

151
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• If you are using AutoStore or both AutoStore and Output Manager, confirm the Web Application
Port value in the application settings matches the AutoStore Konica Minolta iOption component
port setting.
• If you are only using Output Manager, confirm the Web Application Port value in the application
settings matches the Server Port value on the Clients tab in the Output Manager Administration
application.
How edit Application profile settings on page 12 provides more information on application settings.
• Verify that the Use SSL for Web Application setting specified in the application settings for the
device in the Device Registration Service matches the Use SSL setting in AutoStore or Output
Manager:
• If you are using AutoStore or both AutoStore and Output Manager, confirm the Use SSL for Web
Application setting in the application settings matches the Use SSL setting for the AutoStore
component.
• If you are only using Output Manager, confirm the Use SSL for Web Application setting in the
application settings matches Use SSL on the Clients tab in the Administration module of Output
Manager.
How edit Application profile settings on page 12 provides more information on application settings.
• Test the Authority Application by creating a dummy device without registering it on an actual device
in Device Registration Service and then typing the following address in a web browser:
http://server_IP_address:3348/Authority
This assumes that Device Registration Service uses default web application port 3348 and the Use
SSL value is False.
• Test the OpenAPI Authority by typing the following address in a web browser:
http://server_IP_address:13353
This assumes the OpenAPI authentication uses default port 13353 and the Use SSL value is set to
False.
• Restart the device and the AutoStore or Output Manager service.
• Verify that there is no firewall software or hardware blocking the specified port and that IP routing has
been set up to enable communication on this port.

Unified Client application connection errors

• Verify that the AutoStore and Output Manager servers are started.
• Verify that the port specified in the application settings for a device in the Device Registration Service
matches the port specified in AutoStore or Output Manager:
• If you are using AutoStore or both AutoStore and Output Manager, confirm the port used by the
device in Device Registration Service matches the Web Server Port setting in the Preferences
for the Konica Minolta iOption component in AutoStore Process Designer.
• If you are only using Output Manager, confirm the Web Server Port setting in the application
settings matches the Server Port setting on the Clients tab in the Output Manager Administration
application.
How edit Application profile settings on page 12 provides more information on application settings.

152
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Verify that the Use SSL for Web Application setting specified in the application settings for the
device in the Device Registration Service matches the Use SSL setting in AutoStore or Output
Manager:
• If you are using AutoStore or both AutoStore and Output Manager, confirm the Use SSL for Web
Application setting in the application settings matches the Use SSL setting for the AutoStore
component.
• If you are only using Output Manager, confirm the Use SSL for Web Application setting in the
application settings matches Use SSL on the Clients tab in the Output Manager Administration
application.
How edit Application profile settings on page 12 provides more information on application settings.
• Test the Authority Application by creating a dummy device without registering it on an actual device
in Device Registration Service and then typing the following address in a web browser:
http://server_IP_address:3348/Authority
This assumes the Device Registration Service uses default web application port 3348 and the Use
SSL setting is False.
• Test the OpenAPI application by typing the following address in a web browser:
http://server_IP_address:13351
This assumes the OpenAPI application port uses default port 13351 and the Use SSL setting is
False.
• Restart the device and the AutoStore or Output Manager service.
• Verify that there is no firewall software or hardware blocking the specified port and that IP routing has
been set up to enable communication on this port.
• If a user changes the default functionality for Nuance Combined Client for Konica Minolta from
Equitrac to Output Manager or from Output Manager to Equitrac, or the default functionality is
switched to AutoStore, the Unregister Client and Reregister Client actions should be applied for the
DRS device on the server. Otherwise the device panel displays an error message that it is unable to
connect to the server.

Unified Client resets too quickly

Problem description When the user is working on the Konica Minolta

iOption client screen, the screen resets after one
minute, even if the user pressed buttons on the
screen within the last minute.
Cause The Auto Reset System setting in the MFP is set
to 1 minute.
The Auto Reset Setting controls the timeout
for the MFP client. This timeout is not reset
when buttons are pressed in a browser-based
application such as the Konica Minolta iOption
Unified Client.
Solution Increase the device timeout interval to 3 minutes.
See Configure MFP Auto Reset Settings on page
87.

153
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Unified client registration error messages

Code Message Comments

502 Unable to proceed. The device may be in faulted

Please restart device. state or the device does not
support OpenAPI. If the device is
started and this error still occurs,
contact Nuance Communications
Support.

503 Invalid password. Please Verify that you enter the correct
retry login. device admin password in the
device Details pane in Device
Registration Service.

504 Unable to connect to

device. Please restart
device.

505 Maximum registered

applications exceeded.
Please remove unused
applications and retry.

506 Device is locked. Please Verify that the device is not

retry later. in authentication mode or
application mode.

507 Logo icon file does not Contact Nuance

exist. Contact Nuance Communications Support.
Communications Support.

508 Device solution key Contact Nuance

file not found. Contact Communications Support.
Nuance Communications
Support.

509 Invalid Output Manager The Output Manager server

server address. Enter address is blank. Enter the
correct server address Output Manager server on the
and retry. Applications tab in Device
Registration Service or set
Enable Print Release as False
in the device Details pane.

511 iOption not supported

on device. Add iOption
or use the Native Scan
connector.

154
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Code Message Comments

512 Invalid password. Enter Reenter your credentials using a
the valid password and valid password.
retry.

518 Invalid AutoStore server The AutoStore server address

address. Enter the valid is blank. Enter the AutoStore
address and retry. server on the Applications tab
of Device Registration Service or
set Enable Scan as False in the
device Details pane.

519 Invalid Web application The Web Application Port

port number. Enter the setting is blank or contains a
valid port number and negative number. Enter a valid
retry. port number forWeb Application
Port on the Application tab of
Device Registration Service.

Authentication registration error messages

Registration requires that the device is on and functioning normally. Ping the device or access
PageScape to verify that the device is communicating with the network. The AutoStore and Output
Manager services do not have to be running when you perform the registration.

Code Message Comments

502 Unable to proceed. The device may be in a faulted

Please restart device. state or the device does not
support OpenAPI. If the device is
started and this error still occurs,
contact Nuance Communications
Support.

503 Invalid password. Please Verify that you enter the correct
retry login. device administrator password.

504 Unable to connect to

device. Please restart
device.

506 Device is locked. Please Verify that the device is not

retry later. in authentication mode or
application mode.

155
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Code Message Comments

509 Invalid Output Manager The Output Manager server
server address. Enter address is blank. Either enter the
correct server address Output Manager server address
and retry. on Applications tab of DRS
or set Enable Print Release
as False on Devices tab of the
Device Registration Service.

Konica Minolta iOption: AutoStore and Equitrac are

An error occurred installed on the same machine
when initializing web and Equitrac is configured to use
application. Failed the same port as AutoStore. The
to listen on prefix default for both applications is
'https://+:port/' 3348. To correct this problem,
because it conflicts you must change the port
with an existing used by Equitrac. To do this,
registration on the edit the port setting in the
machine. KonicaPanelClient.properties
file. The location for the
KonicaPanelClient.properties
is here:
C:\ProgramData\Nuance
\DeviceControlService
\Settings
\KonicaPanelClient.properties
For more information, see Web
Application Port.

Unified Client unregistration error messages

Unregistration requires that the device is on and functioning normally. Ping the device or access
PageScape to verify that the device is communicating with the network.

Code Message Comments

502 Unable to proceed. The device may be in a faulted

Please restart device. state or the device does not
support OpenAPI. If the device
is started and this still occurs,
contact Nuance Communications
Support.

503 Invalid password. Please Verify that you enter the correct
retry login. device administrator password.

156
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Code Message Comments

504 Unable to connect to
device. Please restart
device.

506 Device is locked. Please Verify that the device is not

retry later. in authentication mode or
application mode.

513 Unregistration failed There is no registered Unified

because no unified Client application.
client has been
registered.

Orphan Unified Client button on the device

Use the Konica Minolta MFP component to remove the button:
1. Open the Konica Minolta MFP component Properties dialog box.
2. Click Device Manager.
3. Enter values for IP Address and Admin password and click the Application list button.

4. Select the Unified Client application and click Delete.

157
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Landing page not visible after changing Device Landing Page device setting
The device landing page is not visible after changing the Device Landing Page option in the DRS
device settings. This may occur if the DRS Server and the Print Manager server are not updated.
To resolve this problem, restart both the Nuance Device Registration Service on the DRS server and the
Print Server (Output Manager or Equitrac).

Device panel blocks usage during session

Problem description After a user exhausts their allowed color quota

within a session, the device panel may present
a blocking screen to prohibit any further device
usage within that session. This includes all
copying, scanning, and print activity.
Cause This is due to interactions between credit limit and
color quota enforcement.
Solution Log out and log in to initiate a new session. This
resets the device usage limits, which allows the
user to continue scanning, monochrome printing
and monochrome copying.

Incorrect balance displayed for Equitrac copy jobs

Problem description The balance displayed on the device panel is

insufficient for copy jobs even when the balance is
still sufficient for copy jobs.
Cause Equitrac 5.7 does not provide cost information to
the Combined Client for Konica Minolta. It only
provides the number of black and white and the

158
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

number of color pages allowed. The number of

color pages is subject to two limitations
• The cost of each page when compared against
the balance.
• The color quota.
To reconcile this, the client estimates page costs
and, when a color quota applies, calculates based
on the cost of a color page. A user at the device
may therefore see the balance drop to 0 even
when there are sufficient funds to continue with
black and white copies.

Solution Log out and then back in to get an updated

balance.

159
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Combined Client for

Ricoh

Overview of the Nuance Combined Client for Ricoh

The Nuance Combined Client for Ricoh provides a combined client for capture and print manager
functionality on Ricoh multifunction printers (MFPs) and devices (MFDs). Your business requirements
determine capture and print manager requirements for your environment. Device Registration Service
to deploy embedded client on Java-enabled devices and configure it to either or both capture and print
on a client. Capture (with process and route) functionality is supported by Nuance AutoStore, while print
management may be supported by either Nuance Equitrac or Nuance Output Manager.
The following figure illustrates the architecture for a system that includes the Nuance Combined Client
for Ricoh:

160
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 7: System architecture with Nuance Combined Client for Ricoh

The Nuance Combined Client for Ricoh provides device authentication with a single application for
Equitrac Follow-You Printing and scanning into AutoStore workflows. This client secures access to
devices, allows user to toggle between Follow-You Printing and scanning, provides card reader support,
searchable billing codes at device login, and job accounting.
The Nuance Combined Client for Ricoh supports AutoStore, Equitrac, and Output Manager
authentication through user name and password, card identification (ID) with an optional personal
identification number (PIN), and card swipe with an optional PIN.
The Nuance Combined Client for Ricoh supports single sign-on (SSO) for the following systems:
• Adaptable Authentication API (AAA): Ricoh SSO infrastructure.
• Internal authentication: built-in MFD logon mechanism.
• Card Authentication Package (CAP): Card logon product from Ricoh.
The Nuance Combined Client for Ricoh can collect accounting data to enable you to track usage for up
to three billing accounts.

Checklist: Nuance Combined Client for Ricoh Implementation

This implementation check list covers aspects deploying the Nuance Combined Client for Ricoh to
devices from the Device Registration Service web client.
This checklist should evolve based on the experience you gain from performing deployments. You might
also want to perform custom checks that are based on a specific aspect of your network architecture or
environment.

161
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Table 3: Ricoh Combined Client Checklist

Check Description See

Confirm that your system meets • Requirements on page 163

requirements.

For AutoStore capture • Ricoh ESA component help in

functionality, add and configure AutoStore Process Designer.
the Ricoh ESA component in an
AutoStore workflow using the
AutoStore Process Designer.

To use Equitrac as the Print • Equitrac Express

Manager, configure the Ricoh Administration Guide
CC embedded type on the
Equitrac server.

To use Output Manager as the • Output Manager

Print Manager, configure the Administration Guide
Ricoh embedded device type in
Output Manager.

Add a DRS application for • Add an application

Nuance Combined Client for • Nuance Combined Client for
Ricoh. Ricoh application properties
on page 215

Add or import a Nuance • Add a device

Combined Client for Ricoh • Import a device
device. • Device properties for Nuance
Combined Client for Ricoh on
page 217

Setup, uninstall, configure, or • Nuance Combined Client for

reboot a Nuance Combined Ricoh actions reference on
Client for Ricoh device. page 227

162
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Requirements
The following table describes system requirements for the Nuance Combined Client for Ricoh.

Component Requirement
AutoStore The following are required if capture with
AutoStore is enabled in Device Registration
Service.
• Version 7.0 SP1 or later
• Licensed for Ricoh ESA capture component
• Workflow configured with the Ricoh ESA
capture component

Equitrac The following is required if print management with

Equitrac is enabled in Device Registration Service.
• Equitrac Office or Express 5.6
• Configure Ricoh CC embedded type

Output Manager The following is required it print management with

Output Manager is enabled in Device Registration
Service.
• Build 4.0 SP1
• OM Device configured with:
• Embedded client type set to Ricoh
• Unified client option is selected
• OM Destination associated with the OM
Device with the correct printer family definition.
• Destination Group with Pending Queue.
• OM Source Output Setting configured to
Route to the Pending Queue.

Java The Nuance Combined Client for Ricoh supports

devices with the following versions of the Java
platform:
• 4.x
• 5.x
• 7.x, except for 4-line LCD devices
• 10.x
• 11.x
• 12.x
Refer to the Ricoh brand matrix to determine the
Java platform version on a device.

163
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Component Requirement
Languages The Nuance Combined Client for Ricoh provides
localization support for the following languages:
• Spanish (Latin American)
• German
• Italian
• Dutch
• Danish
• Swedish
• French
• Portuguese (Brazilian)
• Norwegian
• Finnish

Card readers The Nuance Combined Client for Ricoh has been
tested for the following card readers:
• RFIDeas, MS3-00M1AKU, pcSwipe, Card:
magnetic stripe.
• RFIDeas, RDR-6081APU pcProx. Card: HID.
• RFIDeas, RDR-6381APU pcProx. Card:
Indala®/Motorola 26 bit.
• RFIDeas, RDR-7581APU pcProx. Card:
• MIFARE® CSN
• MIFARE® DesFire CSN
• ISO 14443A/15693 CSN
For RFIDeas readers, the second to last character
in the model number indicates the device color
(P=Pearl, K=Black, and W=White). Differences in
this character do not affect device compatibility.
For the current list of Equitrac supported card
formats, refer to the Equitrac supported card
formats page on the Nuance web site.

CAC Authentication To run the Nuance Combined Client for Ricoh with
the CAC solution, ensure compliance with the
following before installing the Nuance Combined
Client for Ricoh:
• CAC Authentication application is set to have
first priority.
• Device heap stack is set to a minimum of 45
MB.

Supported devices • Nuance Supported Device Search: Ricoh

164
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configuring the Nuance Combined Client for Ricoh

Configure Output Manager
This procedure provides the high-level steps for configuring Output Manager server settings for the
Nuance Combined Client for Ricoh.
Complete the following procedure if the device Authentication property is set to OM Authentication or
OM Authentication with Device Access Control.
1. Start the Output Manager Console application and log in.
2. Configure SSL settings as described in Configure the SSL port.
3. Configure devices as described in Configure Output Manager devices.
4. Configure copy quota settings as described in Configure copy quota for users.

How to configure the SSL port

Follow the steps in this procedure to configure the Output Manager SSL port for the Nuance Combined
Client for Ricoh.
1. On the Output Manager machine, select Start > All Programs > Output Manager Server > OM
Server Configuration .
2. Click the SSL Certificate Manager tab and configure the port for DdmInterface.

Click Help for more information on configuring SSL settings.

165
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure Output Manager devices

This topic describes how to configure devices in the Output Manager Console.
1. On the Output Manager server, select Start > All Programs > Output Manager > Output Manager
Console > Output Manager Console and connect to the Output Manager server.
2. In the Devices application, right-click the device and select Configure.
3. Click the Device Details tab.
4. For Embedded client type, verify that Ricoh is selected.
5. Configure devices for accounting, and then complete the following steps:
a) Configure the device for external authentication.
For more information, see Configure a device for external authentication on page 185.
b) Enable Output Manager login for Nuance Combined Client for Ricoh.
See How to configure sign-in methods on page 168.
c) Set Manage login in Output Manager to External.
6. Configure devices for access control.
7. Configure devices for print preferences.
8. Configure devices for login methods.
9. Configure devices for billing accounts.
10.Configure user copy quotas for devices.

How to configure device for accounting

This procedure describes how to configure a device for accounting.
If the Device Configuration dialog box for the device is not open already, follow the instructions in
Configure Output Manager devices before continuing with this procedure.
Note: Accounting data for Output Manager print jobs and the Nuance Combined Client for Ricoh
scan jobs is always recorded, regardless of settings configured with this procedure.

1. In the Device Configuration dialog box, click the Device Details tab.
2. For Cost Management, select Prints or Copies depending on your business requirements.
3. If you selected Copies, specify the cost per page.
If the Nuance Combined Client for Ricoh is already started, restart it to implement the changes.

How to configure device for access control

This procedure shows how to create access control profiles for users, groups, and departments.
If Device Configuration dialog box for the device is not open already, follow instructions in Configure
Output Manager devices before continuing with this procedure.
Perform these steps only if access control is required.
Access control can be configured for users, groups, and departments. If access control is not
configured, a default profile with full access is provided for new users.
1. In the Device Configuration dialog box, click the Device Details tab.
2. Select Unified client.
3. In the Unified Client box, click Configure access control.
4. Click the appropriate tab to configure access control for Users, Groups, or Departments.
5. Click the browse button (...) for the user, group, or department that you want to configure.

166
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. In the Manage MFP ACL Profiles dialog box, you can create or edit ACL profiles for the selected
user, group, or department.
7. Click New to create an MFP ACL profile.
You do not need to restart the Nuance Combined Client for Ricoh to implement the changes. The
changes take effect the next time users log in to the Nuance Combined Client for Ricoh.

How to configure device for print preferences

MFP Kiosk Preferences profiles make print preference available to users.
If Device Configuration dialog box for the device is not open already, follow instructions in Configure
Output Manager devices before continuing with this procedure.
Perform these steps only if you want users to adjust print preferences before printing.
1. In the Device Configuration dialog box, click the Device Details tab.
2. Select Unified client.
3. In the Unified Client box, click New.
4. Type a name for the profile in the Name field.
5. Optional: Type a profile description in the Description field.
6. Click the arrow next to any item to expand an option group.
7. Select the check box next to a print option to add it to the Selected items list.

167
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

8. Click OK.
If the Nuance Combined Client for Ricoh is already started, restart it to implement the changes.

How to configure sign-in methods

This procedure describes how to configure the sign-in methods for Output Manager users.
1. Start the Output Manager console and connect to the server.
To start the console, select Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application.
3. In the Administration options, click Set General Preferences.
4. In the Administration - Set General Preferences settings, click the Security tab.

168
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. Select options in the External client login section as described in the following table:

Option Description
Allow user name / password The user can log in by entering user name,
password, and selecting a domain.

Allow card swipe The user can log in through a card swipe. The
user must also enter a PIN if Require PIN with
card swipe is selected.

Allow manual card ID entry The user can log in by entering an ID. The
user must also enter a pin if Require PIN with
manual entry is also selected.

Allow unmasked card ID The card ID will be readable as it is entered.

If you clear this check box, the card ID will be
masked.

Default manual login method Select the default user login method:
• Card ID Entry
• User Name/Password

Require PIN with card swipe Users must also enter a pin when using a card
swipe.

169
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Require PIN with card ID entry Users also enter a PIN when using manual card
ID entry.

6. Click Apply.
7. Restart Output Manager.

How to configure billing accounts

This procedure describes how to configure billing accounts and scan properties for Output Manager
users.
1. Start the Output Manager Console and connect to the server.
To start the console, click Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application.
3. In the Administration options, click Manage Billing Accounts.
4. In the Administration - Manage Billing Accounts settings, you can create or edit a billing list and
its billing accounts.

5. You can create secondary billing accounts under the main accounts.

170
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

The following steps associate the billing lists to users:

6. Click the Administration application again, and in the Administration options, click Manage Users.
7. In Administration - Manage Users, select a user and click the Device Profile column to select or
edit an existing profile or to create a new profile.

171
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

8. In a profile, you can create a single billing list, two billing lists, or one primary list and one secondary
list.

9. Click OK.
You do not need to restart the Nuance Combined Client for Ricoh. Users see the changes after their
next login.

How to configure copy quotas

This procedure describes how to configure the copy quota for a user.
1. Start the Output Manager Console and connect to the server.
To start the console, click Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application button.
3. In the Administration options, click Manage Users.
4. In the Administration - Manage Users pane, click the Balances tab.

172
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. For a user, select the check box in the Set Balance column, and click the browse button (...) in the
Allowances Profile column to create or edit profiles.

6. Click New or Edit to set allowances for print and copy.

7. Click OK to save changes to the profile and then click Close.

173
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

8. Click the profile list the Allowances Profile column to assign the allowances profile to the user.

You do not need to restart the Nuance Combined Client for Ricoh. Users see the changes after their
next login.

Accounting
The Nuance Combined Client for Ricoh uses accounting flags to perform accounting operations.
Collecting accounting data is achieved through the following actions:
• Output Manager server tracks print activity.
• Output Manager server tracks AutoStore scan activity.
• Print and native copy activities are tracked according to the accounting flags. AutoStore scan
activities are also tracked.
The Nuance Combined Client for Ricoh records accounting data for color and black and white content
as follows:
• When a user logs in at a device, the Nuance Combined Client for Ricoh reads the device print and
copy counters. When the user logs out, the Nuance Combined Client for Ricoh reads the counters
and records the differences since the start of the session.
• The Nuance Combined Client for Ricoh records data for configured billing accounts. When the user
changes the billing accounts while logged in, the Nuance Combined Client for Ricoh records the
counter differences before each change.
• For an Output Manager print job, the Output Manager server records its accounting data at the end
of the job regardless of the accounting settings. The Output Manager server uses the recorded print
counters to reconcile the accounting data.
• For an AutoStore scan job, the Nuance Combined Client for Ricoh records its accounting data at the
end of the job regardless of the accounting settings.

Enable quota management

This topic describes how to enable quota management on a device.
Configure the following to have Output Manager to use quota management:

Do this See
Enable external authentication Configure a device for external authentication

Set manageLogin to external

174
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Do this See
Set the allowance profile Configure copy quota for users

Note: Output Manager cannot do quota management on 2.x devices, as they do not support external
authentication.

Quota is checked at login time, and during and after a copy session. After the limit is reached, the
Nuance Combined Client for Ricoh issues a command to stop copy. The command turns off all device
functions, including copy, scan, and fax. Depending on the device capabilities, it may continue copying
pages before its functions are turned off. On the device panel, the user is prompted for a key card, while
the Print Manager shows that the quota has been reached on a device.

Configure AutoStore
Add the Ricoh ESA component to an AutoStore workflow to provide capture functionality for Nuance
Combined Client for Ricoh. When you create the DRS application, specify the AutoStore server address
as well as the port number specified on the Preferences tab of the AutoStore component configuration.
For details about configuring the Ricoh ESA component in AutoStore, refer to the component help in
AutoStore Process Designer.

Configure Equitrac
Configure the authentication for the Nuance Combined Client for Ricoh component to work with Equitrac
authentication.

Server side configuration

To enable Nuance Combined Client for Ricoh, you must add the Embedded device to the available
devices in System Manager, and initialize the device.
In order to do this, as a prerequisite, you must have:
• A Physical Device with a Print Queue
• Secure Document Release (SDR) must be enabled for the device.
Note: For information about adding physical devices and enabling SDR, please see the Equitrac
Express Administration Guide.

Configuring Secure Printing

Controlled Ricoh CC MFPs must use secure printing environment.
To configure a secure print environment, the print queue must be configured to hold print jobs.
1. In System Manager, navigate to Configuration > Devices >.
2. Click on the Print queue you want to configure. You may need to expand the Physical device to see
the print queue.

175
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The print queue is created automatically the first time a user prints to the controlled device,
including when you print a test page upon configuration. If a print queue does not appear beneath
the Physical Device, send a print job to the MFP, then wait 30 seconds and refresh System
Manager.
3. In the Print queue summary dialog box, set the Secure printing option to Enabled from the Behavior
section, and click OK.

After completing these steps for each device, you need to configure the Ricoh CC embedded device.
See How to configure an embedded device on page 176.

How to configure an embedded device

You must create an embedded interface for each Ricoh CC MFP that will be controlled by Equitrac
Office and Express. The Equitrac System Manager component provides the tools to create these
interfaces.
Embedded devices are manufacturer-specific software components that handle the transfer of user
authentication and transaction details between these devices and your accounting server database.
Supported devices prompt users for valid user and account ID information for all print release, walk-up
copy, scan, and fax jobs.
1. Add the Nuance Combined Client for Ricoh device to the system.
2. Open System Manager and select Devices in the left pane. The device will appear in the Devices
list. Right-click on a Ricoh CC MFP physical device node in the right pane, then select Add
embedded device... from the menu.

176
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

This opens the Embedded device window.

3. In the Type box, select Ricoh CC.

4. Enter a Name and Description for the device. These are required fields, and cannot be left blank.
The content can be changed if necessary.
5. Select the Server hosting the DCE associated with this physical and embedded device from the
drop-down list. The Version field fills automatically.

177
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: If you change the server associated with an embedded device that has already been
initialized by the Equitrac server, you must re-initialize the device.

6. Select the Card Reader HID decoding from the drop-down list. For details on HID decoding, see the
Equitrac Office and Express Administration Guide.
7. Click Pricing to configure pricing at the embedded device level. To configure the embedded device
to use the price list for that device, select the default price list. If you select an alternate price list for
the embedded device, the embedded device price list overrides the default price. For pricing details,
see Configuring Price Lists in the Equitrac Office and Express Administration Guide.
8. Click the link beside Tracked activities to override default tracking options for a particular embedded
device.
Note: If a device is using third-party scan tracking, then native scan tracking should not be used
because it results in duplicate counts. Opting out of native scan tracking also disables other native
scan options.
9. Click the Initialize button. This configures communication between this device and the Equitrac
server and returns to the Embedded device dialog box.
CAUTION: Clicking Initialize changes the configuration on the device itself and may require the
MFP to restart. Ensure that the MFP is not in use before you click Initialize. Click the Reboot
button on the MFP web configuration page to accomplish the restart remotely if necessary.

How to configure authentication prompts

The user authentication prompts on the MFP login screen are determined by your Equitrac Office and
Express configuration.
1. In System Manager, navigate to Configuration > Security and authentication > User
authentication.

178
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Select one of the following Authentication options from the Input type list box:
Option Description
Card swipe only Users authenticate with a swipe card.
Card swipe or keypad entry Users authenticate with a swipe card or at the
MFP front panel.
Keypad only Users authenticate at the MFP front panel.
3. Select one of the following options from the Secondary prompt list box:
Option Description
Always User must enter a secondary PIN if issued using
the soft keyboard.
If PIN2 available User must enter a secondary PIN if they have a
PIN 2 value associated with their user account.

179
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
If PIN2 available or keyboard login User must enter a secondary PIN if they have a
PIN 2 value associated with their user account,
or if they entered their primary PIN using the soft
keyboard.
Never Secondary PIN is not required. The Nuance
Combined Client for Ricoh allows the user to
log in by specifying a single PIN (primary PIN or
alternate primary PIN)
Only with keyboard login User must enter a secondary PIN using the
soft keyboard if issued after they entered their
primary PIN via the keyboard (rather than with
a swipe card). This option adds an extra layer
of security, preventing users without a card from
logging in without a secondary PIN.

Note: The Secondary PIN is not required if swipe card is used to log on to the embedded client.

4. In the Card setup area, enter the data start and stop positions in the Use data from position.
For details on entering HID decoding parameters, refer to the Using PageCounters chapter in the
Equitrac Express Administration Guide.
5. Select Auto-register primary PINs if you want users to register an unrecognized swipe card for
future use.
An External authority must be selected to allow card self-registration.
6. Click OK to save the change.
For more detailed user authentication options see Accounts System Configuration in the Equitrac
Express Administration Guide.

How to configure card self-registration

When a user swipes an unregistered card, they are required to manually login in order to register the
card’s PIN. After the card registration a pop-up message appears with a logout button.
If you want users to self-register their swipe cards, you must enable this option in System Manager.
The User ID must already exist in CAS, or in the External authority defined to allow self-registration.
The Password comes from one of the defined external authorities. The information the user must enter
depends upon the authentication options that are set in System Manager. Two-level authentication is
required to register new cards, and the user must manually enter both primary and secondary login
credentials.
1. Open System Manager and navigate to Configuration > Security and authentication > User
authentication.

180
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. In the Authentication optionssection, do the following:

a) Set the Secondary Prompt to Never. Ricoh CC allows the user to log in by specifying a single
PIN (primary PIN or alternate primary PIN).
b) Select the Auto-register primary PINs check box. Optionally, you can select Register as
alternate PIN to record the PIN as the Alternate PIN instead of the Primary PIN.
3. Select one or more Authentication mechanisms supported by Ricoh CC:
• Equitrac Office/Express PINs – Select to connect an Equitrac print account with login
information.
• External user ID and password – Select to verify all user information outside of Equitrac.
• Equitrac Office/Express PIN with external password – Select if the user enters the Equitrac
PIN and the domain user account password. Equitrac cross-checks the database for the
corresponding Equitrac account name, then verifies the credentials against the selected external
authority for network logon.
4. Click OK to save the changes and close the User authentication dialog box.

181
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. Navigate to Configuration > Security and authentication > External authentication and select an
External authority – Windows or LDAP. Refer to External User Authentication in the Equitrac Office/
Express Administration Guide for more details on setting up an external user authentication method.
After a user register their card, the user's account information is automatically associated with that card.
The user can next time swipe the card to log in automatically without manually entering a password.

How to configure billing codes for Nuance Combined Client for Ricoh devices
1. In System Manager, navigate to Configuration > User interaction > Session flow.

2. Select Prompt for billing code after user identification (at copiers) if you want the user to enter a
billing code immediately after authentication.
If the user has only one associated billing code, then the prompt is suppressed, and the billing code
is automatically applied to the job (valid for the copy and scan operations during the user session).
3. Select Prompt for billing code at job release (at copiers) if you want the user to enter a billing
code before they can release a print job.
If the user has only one associated billing code, then the prompt is suppressed, and the billing code
is automatically applied to the job (valid for a single job for the print operation).
4. Select the Billing code prompt details you want to display at the MFPs.
Option Description
Required field The user must enter a billing code. Users with
only one billing code are not prompted for a
billing code even if the Required field option
is selected. Instead, the embedded device acts
as if the user has entered one. If this option is
not selected, and the user does not have an
associated billing code, they can enter a "blank"
billing code to continue.

182
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Search Adds a Search function where users can search
for billing codes.
Security mode Displays the Billing code in asterisk characters.
Show most recently used Does not apply to Ricoh CC embedded devices.
Default to the previous billing code Does not apply to Ricoh CC embedded devices.
5. Enter a name for the Billing code label on the MFP panel (for example, Billing Code).
6. Set the Billable option (Prompt for Billable and Billable label).
7. Validate billing codes against CAS when it is available and/or unavailable (at workstations only) in
their respective fields.
8. Click OK to save the settings.
How to configure a default billing code
Follow steps in this procedure to configure a default billing code for Nuance Combined Client for Ricoh.
1. Create a price list for printing and scanning.
2. Assign this price list to the device and to the embedded client.
3. Create a billing code, create a user and set the default billing code as described above.
Note: Make sure the user and billing code have different balance.

4. Click OK to save the settings.

How to enforce color quotas

Ricoh CC can enforce limits on the number of color copies that any user can make, based on their user
account quota limits.
When configured to enforce color quotas, the Ricoh CC can disable the MFP when a user exceeds their
color copy limit. For a more detailed discussion about Color Quotas, see the Equitrac Office/Equitrac
Express Administration Guide.
To enable Nuance Combined Client for Ricoh to enforce color copy quota limits, do the following:
1. Open System Manager and navigate to Configuration > Accounting and quotas > Color quota.

2. In the Color quota dialog, select Enable color quota.

3. Select Disable copying on color devices once quota exceeded.
This disallows black and white copying, and stops color copies if users exceed their color quota
limits. This enforces color copy to stop at:

183
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Start of session (if user does not have positive color quota at login)
• Never (not enforced)
4. Enter a Custom message to display to the user when they have exceeded their color quota.
If you do not do this, the color quota limit warning messages appear that describe the amount of
quota needed, the amount of quota available and the account(s) that were checked to confirm quota.
Note: This option is available only if escrow is enabled.

If the color quota limit warning message displays that the printing should be charged to:
• Delegator (delegated job): check the color quota of the delegator instead of the user.
• Both delegated and own jobs in the set: either
• Check the balance of the delegator and the user quota appropriately
• in the case there is not enough color quota to print, the warning message contains all related
accounts, their available quotas and quotas required.
After you dismiss the warning message, you are transferred back to the Follow-You Printing screen
where the same set of documents are selected as prior to your print attempt.
5. Click OK to save any changes.

Receiving Print Error Messages

On specific end-points, if you try to release a print job that costs more than the funds available in the
account, a message displays indicating that there are insufficient funds to release the document. If a
transaction with multiple documents fails due to insufficient funds, then a message displays indicating
the jobs have failed to print. The message does not list all the failed print jobs.

Configure Nuance Combined Client for Ricoh device properties

These sections describes how to configure a Nuance Unified Client for Ricoh Smart Operation Panel
device.

How to install the Nuance Combined Client for Ricoh

Use Device Registration Service to send configuration settings to the MFD.
Before performing this procedure, configure an application profile on the Applications tab and specify it
in a device profile on the Devices tab. For more information about adding applications and devices, see,
Working with Applications on page 11 and Working with Devices on page 13
1. In a supported internet browser, browse to the Device Registration Service web application (for
example, http://10.16.37.51:9000/device).
2. Click Devices and select the device.
3. In the Details pane, select Install or Install Start from the drop-down list box.
4. Click Perform selected action.
5.
Optional: To view registrations for a device, click the device in the Device pane and click the
button on the Details toolbar.

How to modify the Ricoh Xlet

This task describes the steps to modify the Ricoh Xlet so that it can communicate with the DRS server.
1. Verify that you installed the Nuance Combined Client for Ricoh on the device as described in Install
the Nuance Combined Client for Ricoh .

184
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Unzip the 33956099.zip file located in the DRS installation directory (for example, C:\Program
Files (x86)\NSi\Device Registration Service\Service\Plugins\).
3. Open the UnifiedESAXlet.dalp file in a text editor.
4. At the bottom, modify the deviceRegServer and deviceRegPortScroll arguments as follows:

<argument>deviceRegServer=DRS server address</argument>

<argument>deviceRegPort=DRS port number</argument>

The following shows an example configuration.

<argument>deviceRegServer=15.166.37.151</argument>
<argument>deviceRegPort=8353</argument>

Install the SSO Xlet

1. In the Device Registration Service Devices pane, select the device.
2. Click Edit on the Details toolbar.
3. Select True for Print Manager Enable SSO Provider.
4. Click Save.
The system adds the 34084353.zip SSO Xlet file to the Device Registration Service installation
directory (for example, C:\Program Files (x86)\Nuance\Device Registration Service
\Service\Plugins\). How to add a new Device profile on page 13 provides more information on the
Print Manager Enable SSO Provider option.

Configure authentication on a device

Configure a device for external authentication

Complete the procedures in this section to use external authentication to control user access to device
functions. You configure access control settings through Enhanced External Charge Unit Management
in Output Manager.
How to turn off internal authentication
Turn off internal authentication before turning on Enhanced External Charge Unit Management.
1. On the MFP console, press the User Tools hard key or soft key on the Ricoh MFP console.
2. Press System Settings > Administrator Tools.
3. Page down to User Authentication Management.

185
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Press User Authentication Management > Off > OK.

5. On the Administrator Tools tab, press Administrator Authentication Management > User
Management > Off > OK.
How to turn on Enhanced External Charge Unit Management
Turn on Enhanced External Charge Unit Management to activate the settings that control user access to
device functions.
Important: This procedure requires working in Service Mode, which is typically performed by a Ricoh
technician.

1. On the MFP console, go to a function other than User Tools. For example, go to the Copy function.
2. Enter SP mode options.
This displays the SP mode options screen.

186
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Press System Sp.

The SP mode service options appear.

4. Press SP-5XXX and page down until 5113 appears.

5. Press 5113 > 2 to show the COPY : SP-5-113-002 page.
6. Press 1: Expansion Device 1 > OK.
7. Press Exit.
8. Restart the device.

187
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure user access to device functions

Use Enhanced External Charge Unit Management to configure user access to device functions.
1. On the MFP console, press the User Tools hard key or soft key on the Ricoh MFP console.
2. Press System Settings > Administrator Tools.
3. Page down and press Enhanced External Charge Unit Management.
4. Press the category functions for which you want to restrict user access.
For example, if you press Full Color, Single Color, and Two-color and you do not press Black &
White for the Copier category, users can only make black and white copies of documents.
Do not restrict access to the Printer category options and do not restrict access to JavaTM/X in the
Other Functions category. The following figure shows sample settings:

5. Press OK.
How to activate access control for internal authentication
Access for internal authentication is initially not activated by default. To use internal authentication, you
must first activate access control for internal authentication.
Activate access control for internal authentication by entering SP mode at the device and making the
following changes:
• SP-5-401-103 from 0 to 3
• SP-5-401-230 from 0 to 1
Important: This procedure requires working in Service Mode, which is typically performed by a Ricoh
technician.

1. Enter SP mode options.

This displays the SP mode options screen.

188
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Press System Sp.

The SP mode service options appear.

3. Scroll down and press the 5401 button.

4. Press 103, enter 3, and press # to save the setting.

189
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. Press 230, enter 0, and press # to save the setting.

6. Press Exit to exit SP mode.

7. Restart the MFD.

190
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configure a device for internal authentication

To enable authentication through the built-in login screen of the device, enable Internal Authentication at
the device or partially through the Web Image Monitor application.
How to configure LDAP and user authentication at a device
This task explains how to configure LDAP and user authentication at the device.
1. Verify that external authentication is turned off as described in Select functions for access control.
2. Verify that Enhanced External Charge Unit Management functions are not selected.
For information about configuring these functions, see Select functions for access control.
3. Configure the LDAP server required for authentication:
a) On the MFP console, press the User Tools hard key or soft key on the Ricoh MFP console.
b) Press System Settings > Administrator Tools.
c) Page down and press Program / Change / Delete LDAP Server.

d) Press Program > Change and press the LDAP server that you want to configure.
e) Configure LDAP server settings.
Contact your system administrator for the server settings for your environment.
f) Press OK to return to Administrator Tools.
4. Set user authentication to the LDAP server:
a) Press Administrator Tools.
b) Page down and press Administrator Authentication Management.

191
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

c) Press Administrator Authentication Management, press On next to Admin. Authentication,

and press OK.
d) On the Administrator tab, press User Authentication Management > LDAP Auth.
e) Next to LDAP Servers, select the LDAP server that you configured and press Next.
f) For Copier, press None > Next.
g) Next to Other Functions, turn off Document Server, Facsimile, and Scanner, and press OK.
5. Optional: On the Administrator Tools tab, press Enhanced Authentication Management > On >
OK.
This setting affects the device logon screen but not the operation of Output Manager.
6. Restart the device.
How to configure LDAP and user authentication
This task explains how to configure LDAP and user authentication on a workstation using the Ricoh
Web Image Monitor application.
1. Log on to the Web Image Monitor.
2. Browse to the Configuration page.
3. Click LDAP Server under Device Settings.
Internal authentication requires LDAP authentication.
4. Select the LDAP server and click Change.

192
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. Configure LDAP server settings.

Contact your system administrator for the server settings for your environment.
6. Click OK and then click OK to return to the Configuration page.
7. Click Administrator Authentication Management under Device Settings.
8. For User Administrator Authentication, select On.

193
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

9. Click OK to return to the Configuration page.

10.Click User Authentication Management under Device Settings.
• For User Authentication Management, select LDAP Authentication from the drop-down list
box.
• For LDAP authentication, select the LDAP server you configured.

194
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

11.Click OK to return to the Configuration page.

12.Restart the device.
Internal authentication and Address Book
Use the settings configured in this section as a template to create an entry in the device Address
Book. A user has access to a function if it is enabled by internal authentication through the Output
Manager server at login or the user settings in the Address Book. It is recommended that you turn off
the functions in the Address Book so only the server settings are active.
For existing users in the Address Book, it is recommended that you turn off the functions locally or
remotely through the Web Image Monitor application. You can also delete user accounts so new
accounts with correct settings are created the next time the users log in.

Configure authentication settings in Output Manager

How to configure SNMPv3 settings
This procedure explains how to configure the device SNMPv3 settings that are required for using
SNMPv3 with the Nuance Combined Client for Ricoh.
1. Log on to the Web Image Monitor application as an administrator.
2. Click Device Management > Configuration.
3. Click SNMPv3 under Network.
4. Configure SNMPv3 settings as described in the following table:

Setting Description
Account Name(User) Specifies the user account that the device uses
for SNMPv3.

Authentication Password(User) Specifies the password for the user account.

195
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Setting Description
Encryption Password(User) Specifies the password that the device uses for
encryption.

Use the same settings when you add a Ricoh ESA device in Device Registration Service and
configure it for SNMPv3.
Refer to the Ricoh device documentation for more information on other device settings.
Related tasks
How to add a new Device profile on page 13
This task explains how to create a Device profile. The profile enables you to manage Unified Client,
AutoStore, Equitrac or Output Manager, and authentication settings on the Device through Device
Registration Service.

Single sign-on integration

An application participates in SSO in two roles: Authority or Listener. They are defined as follows:
• Authority: An application that provides original login for a user and sends login information to other
SSO applications.
• Listener: An application that receives login information through SSO from other authority
applications.
Nuance Output Manager uses manageLogin parameter to control which role it can play. We describe
the parameter’s impact next. Then we describe SSO configurations for various systems.

Single sign-on integration

An application participates in single sign-on (SSO) in an authority role or listener role.
In the authority role, the application provides the original login for a user and sends login information to
other SSO listener applications. In the listener role, the application receives login information through
SSO from the authority application.
The Nuance Combined Client for Ricoh can function in the authority role for the following authentication
modes:
• Print Manager Authentication with Device Access Control
• Print Manager Authentication
• Device Authentication.
As the authority, the Nuance Combined Client for Ricoh notifies its listeners for login and logout events.
The Nuance Combined Client for Ricoh can function in the listener role for the following authentication
modes:
• External AAA Provider
• CAP
As a listener, the Nuance Combined Client for Ricoh shows a not-logged-in message rather than a login
screen when no user is logged in.

196
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Single sign-on under internal authentication

Internal authentication allows applications to participate in SSO by registering a login plug-in for the
SSO authority or an event listener for a SSO listener.

Figure 8: Internal authentication infrastructure for single sign-on

To configure the Nuance Combined Client for Ricoh as the internal login authority, set Authentication to
Device Authentication in the device Details pane in Device Registration Service.
To configure the Nuance Combined Client for Ricoh as an internal listener, set Authentication to CAP.

Single sign-on under AAA

The AAA infrastructure requires a provider that can broadcast the authority login information to listeners.

Figure 9: AAA infrastructure for single sign-on

To configure the Nuance Combined Client for Ricoh as the AAA authority, follow these steps:
1. In Device Registration Service, select the device in the Devices pane.
2. In the Details pane, set Authentication to OM Authentication with Device Access Control or OM
Authentication.
3. Set Print Manager Enable SSO Provider to True.
4. Install the Nuance Combined Client for Ricoh as described in Install the Nuance Combined Client for
Ricoh .
When the above flag is turned on, both the Nuance Combined Client for Ricoh Xlet and the SSO
provider servlet are installed on the device. Device actions such as Start and Stop apply to both
applications.

197
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

To configure the Nuance Combined Client for Ricoh as a AAA listener, set Authentication to External
AAA Provider. The Nuance Combined Client for Ricoh listens to AAA login and logout events through
Output Manager or AutoStore depending on whether Enable Print Release is set to True or False.

Single sign-on under CAP

The AAA infrastructure requires a provider that can broadcast the authority login information to listeners.

Figure 10: AAA infrastructure for single sign-on

To configure the Nuance Combined Client for Ricoh as the AAA authority, follow these steps:
1. In Device Registration Service, select the device in the Devices pane.
2. In the Details pane, set Authentication to Print Manager Authentication with Device Access
Control or Print Manager Authentication.
3. Set Print Manager Enable SSO Provider to True.
4. Install the Nuance Combined Client for Ricoh as described in Install the Nuance Combined Client for
Ricoh .
When the above flag is turned on, both the Nuance Combined Client for Ricoh Xlet and the SSO
provider servlet are installed on the device. Device actions such as Start and Stop apply to both
applications.
To configure the Nuance Combined Client for Ricoh as a AAA listener, set Authentication to External
AAA Provider. The Nuance Combined Client for Ricoh listens to AAA login and logout events through
the Print Manager or AutoStore depending on whether Enable Print Release is set to True or False.

Using the Nuance Combined Client for Ricoh

Nuance Combined Client for Ricoh login
This section describes how to configure login settings and how to log on to AutoStore, Equitrac, or
AutoStore through the Nuance Combined Client for Ricoh.

Output Manager login

This section describes how to configure login settings and how to log on to Output Manager through the
Nuance Combined Client for Ricoh.
Login settings
This topic describes settings that control the Nuance Combined Client for Ricoh login to Output
Manager.
The Nuance Combined Client for Ricoh login is configured in the Output Manager Console by the
External client login options (see Configure logon methods).

198
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

The External client login The settings define three login methods and two PIN options:
• User name and password login.
• Card swipe login, with optional PIN.
A PIN can be treated as password for a card ID.
• Manual card ID entry login, with option for a PIN.
After you change login settings on the Output Manager server, restart the Nuance Combined Client for
Ricoh to implement the changes. Depending on the selections in the External client login settings,
users see different login options at the Nuance Combined Client for Ricoh.
Typically, all three login methods are enabled. Depending on the default login method selected at the
Output Manager server, the user sees either the user name and password login or the manual card ID
entry login.

Figure 11: User name/password login screen

199
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 12: Manual ID entry login screen

A user can press Switch to switch between these to methods. If one of the methods is not enabled, the
switch button does not appear. For example:

Figure 13: Manual ID entry disabled

Since the Card Swipe Login is always available, there is no need to switch to it and it cannot be
specified as a default login method in the Output Manager server. When Card Swipe Login is the only
method enabled, the screen prompts to swipe a card.

200
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 14: Card Swipe login only

The following screen shows when no login method is available.

Figure 15: No login method available

The user name, password, and card ID or PIN are entered using a soft keyboard.

201
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 16: Soft keyboard

When the Allow unmasked card ID check box is cleared, the entry is obscured as the user types
characters.

Figure 17: Soft keyboard with mask

User name and password entry

This section describes options when supplying a user name and password to log in.
User name and password entry supports the following user types:
• Microsoft Windows domain
• Output Manager
• LDAP realm
The domain, Output Manager, or realm is selected in the Domain list box:

202
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

If the login fails, an error message shows Invalid user name or password:

Card swipe
This topic describes options for the card swipe login.
This login type supports the following features:
• Card can be swiped when the Nuance Combined Client for Ricoh is not the active application on the
device panel. The Nuance Combined Client for Ricoh performs a login in the background. This is
very helpful when the Nuance Combined Client for Ricoh is providing SSO to other applications. The
active application could log in the user after receiving the SSO notification.
• Card can be swiped when the device is in energy-saving sleep mode. The Nuance Combined Client
for Ricoh wakes up the device and logs in the user.
If the Require PIN with card swipe option is not selected, the card swipe logs in a user with a
registered card ID. If the Require PIN with card swipe option is selected, the user enters a PIN.

203
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

If a login fails, the Nuance Combined Client for Ricoh prompts the user to register an ID or PIN.

If the user presses Yes, the Nuance Combined Client for Ricoh prompts the user to log in to assign an
ID or PIN.

If the assignment is successful, the user can use the card ID or PIN for future logins.

204
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Manual ID entry
This section describes options for the manual ID entry login.
Manual ID entry login prompts for both ID or server or registers an unrecognized user. By default, the
manual ID login provides fields for both card ID and PIN for logging onto the server. If the PIN option is
disabled, the Nuance Combined Client for Ricoh shows the login screen without the PIN field.

If a login fails, the Nuance Combined Client for Ricoh prompts the user to register an ID or PIN.

If the user presses Yes, the Nuance Combined Client for Ricoh prompts the user to log in to assign an
ID or PIN.

205
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

If the assignment is successful, the user can use the card ID or PIN for future logins.

AutoStore login
The Nuance Combined Client for Ricoh shows an AutoStore login screen when it is configured to use
the AutoStore login.
The following figure shows a sample screen for the Active Directory login on AutoStore.

206
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Equitrac login
This section shows Equitrac login screens for the Nuance Combined Client for Ricoh.

Figure 18: Equitrac card swipe

Figure 19: Equitrac card ID and PIN

207
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 20: Equitrac login swipe with domain credentials

Figure 21: Equitrac administrator login

Screen layout
After a user logs in, the Nuance Combined Client for Ricoh shows the AutoStore workflow or the Print
Manager screen.
The Nuance Combined Client for Ricoh screen that appears depends on the settings that you configure
in How to add a new Device profile on page 13.

208
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 22: AutoStore screen

Figure 23: Output Manager job screen

Notes:
• The Release my print button in AutoStore does not appear if only scanning is enabled.
• The Close button in the Print Manager screen does not appear if only Print Manager is enabled.
• The number of jobs retrieved from the Print Manager screen is limited to 40.
• Some buttons are disabled when no jobs are selected.

Configuration on the device

Print settings
The Nuance Combined Client for Ricoh can be configured to let users press the Settings on the
console before releasing selected jobs.
The Nuance Combined Client for Ricoh shows the settings that are available and in the order they are
set up in the Print Manager server.

209
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 24: Output Manager Settings screen

Figure 25: Equitrac Settings screen

There are three commands in the Settings screen.

Operation Description
Print Set the preferences and then release the jobs
according to the preferences. If billing lists are
assigned, the Nuance Combined Client for Ricoh
prompts the user with billing account options as
described in Billing Accounts.

Cancel Cancel the print operation.

Done Closes the preferences for the jobs on the Print

Manager server.

210
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Job information
The job information screen shows job details.
The user can select one or more jobs and press Info to view information about each job.

Figure 26: Job Information screen

When multiple jobs are selected, the user can press Previous and Next to navigate the information
screens for the jobs.

Billing accounts
The user can configure a billing account for each print at login or at each release.
The login billing accounts list is called Default Billing Accounts. They are recorded as part of the
accounting data for Copy, Scan, Print, and Fax operations.

Figure 27: Output Manager default billing accounts

211
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 28: Equitrac default billing accounts

The Billing Accounts button is enabled only if Prompt for billing accounts at login is selected at
the Print Manager server. This selection allows a logged in user to change the default billing accounts
during a login session.

View Print jobs

The printed jobs lists show information about completed print jobs.
The user can view and manage jobs in the Output Manager Release my print jobs list.

Figure 29: Output Manager "Release my print" jobs list

212
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 30: Equitrac "Follow-You Printing" jobs list

Button Description
Print Prints the selected job in the list.

Print All Prints all jobs in the list.

Delete Deletes selected jobs in the list.

Info Shows information for a selected job.

Settings Opens the settings screen to configure print

settings.

Billing Accounts Opens the billing accounts screen to search

select an available billing account available for the
current user login.

Printed jobs Displays printed jobs. Clicking this button changes

the label to read Unprinted Jobs. This button is
only available on the Output Manager Release my
print screen.

The number of jobs retrieved is limited to 40. When the user presses Print Jobs, the button changes to
Unprinted Jobs. This allows users to switch from one list to the other.

View Job information

The job information screen shows job details.
The user can select one or more jobs and press Info to view information about each job.

213
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 31: Job Information screen

Figure 32: Equitrac job information screen

When multiple jobs are selected, the user can press Previous and Next to navigate the information
screens for the jobs.

Logout
The Nuance Combined Client for Ricoh supports the following logout options at the MFD:
• Logout button
• Logout by card swipe
• Auto logout
• Energy Saving Mode logout
• Powered off logout

Logout button
The user logs out by pressing Login/Logout on the device panel. The Nuance Combined Client for
Ricoh shows the login screen after the user logs out. For 10.x and later devices, the user can press
Login/Logout to log out even when the application is not the current application on the device panel.

214
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

If the Nuance Combined Client for Ricoh is configured for compatibility with Smart Operation Panel
devices, the user can log out by pressing the graphical Logout button on the Smart Operation Panel
display.

Logout by card swipe

While logged in, the user can swipe a card again to log out. This is a convenient way to log out when the
application is not the current application on the panel, even for pre-10.x devices.

Auto logout
If the user forgets to log out, the Nuance Combined Client for Ricoh automatically logs out the user after
the user has not been active on the MFD control panel for a specified time-out interval. The time period
is specified as the number of seconds through the OM Application Timeout property in the device
Details pane in Device Registration Service.

Energy Saving Mode logout

When the device enters Energy Saving Mode while the user is logged in, the Nuance Combined Client
for Ricoh logs out the user before the device shuts down.

Powered off logout

When the device is powered off manually or through auto-power off timer, the Nuance Combined Client
for Ricoh logs out the user before the device shuts down.

Reference
This section describes options for the Nuance Combined Client for Ricoh objects and documents return
codes.

Nuance Combined Client for Ricoh application properties

A Device Registration Service application profile for the Nuance Combined Client for Ricoh specifies
connection information for an AutoStore server and a Print Manager server. This information allows an
MFP or MFD to use capture and print management services on these servers.
These properties appear in the Device Registration Service Details pane when you add or edit a
Nuance Combined Client for Ricoh application. You cannot change the application type for an existing
application.

Property Description

Name A name that uniquely identifies an application.

215
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Application Type To create a new Nuance Combined Client for
Ricoh application in DRS, choose Ricoh ESA for
this option.
The remaining properties shown here appear after
you make this selection. You cannot change the
application type after you save a new application
profile.

AutoStore Server Address The IP address, computer name, or DNS name of

an AutoStore server.

AutoStore Server Port The port that the AutoStore server uses to
communicate with clients.
This setting must match the port number that is
set on the Preferences tab of the Ricoh ESA
component settings in AutoStore. The default is
8084.

Print Manager Server Address The IP address of the Equitrac or Output Manager
server.

Print Manager Server Port The port that the Equitrac or Output Manager
server uses to communicate with clients.
This setting must match the port that is set for the
Equitrac or Output Manager server. The default
settings are the following for Equitrac and Output
Manager:
• Equitrac: 8443 for HTTPS (SSL)
• Output Manager: 8068 for HTTP and 8069 for
HTTPS (SSL)

DRS Server Address The IP address of the Device Registration Service.

DRS Server Port The port that the Device Registration service uses
to communicate with clients.
This setting must match the port that is set for the
Device Registration Service. The default is 8753.

Active Print Manager Specifies the print manager type. This should
correspond to the server type specified by the
Print Manager Server Address.
• Equitrac
• Output Manager

216
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Device properties for Nuance Combined Client for Ricoh

Nuance Combined Client for Ricoh device properties are configured in the Device Registration Service
web console. When configured for a device group, they can be propagated to any device in the group.

These parameters define the device settings. Click the edit button to edit the parameters for a
device. Click the save button to save changes to the parameters or click the cancel button to
discard changes.

Option Description

Name The name of the Ricoh device or device group.

Address The IP address or DNS address of the Ricoh

device.
Note: This is a device only parameter
and will not be displayed when configuring
parameters for a device group.

Inherit Properties from Group This option only appears for a device that is a
member of a device group.
• Click True to use device settings that are
configured for the group. This is the default
setting when you create a new device profile in
a group. The current group settings although
visible cannot be changed. You can only
change group membership defined by the
Device Group setting.
• Click False to configure settings for this device
profile. Choosing this setting allows you to
configure all of the settings for a device. The
default settings after you choose this option
will initially be the same as are configured for
the group, so you only need to change those
settings that you want to be different. Any
changes made to the group settings while this
False will not propagate to the device.

Username The administrator user name for the Ricoh device.

The default is "admin".
Note: Username is not required to perform
a selected action on the device.

Password The administrator password for the Ricoh device.

The default password is none.

217
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Application The application that is associated with the Ricoh
device or device group.

Device Group Click a group name in this box to change group

membership. When a device is a member
of a group in can optionally inherit device
settings defined for the group. This allows you
to simultaneously manage settings for multiple
devices. Select the [Devices] option in this list to
entirely remove a device from group membership.

Remote Install Password The remote password for the Ricoh device. This
password is required for uploading the Nuance
Combined Client for Ricoh Xlet to a Ricoh ESA
device. The default remote install password is
"ricoh".

Enable Print Release Set this to True to enable the Print Manager after
login. The default value is True.

Enable Scan Set this to True to enable the AutoStore scan

functionality. The default value is True.

Default Functionality Specifies to initially display the capture or print

function (AutoStore or Print Manager) after a
user logs on to a device. The default setting is
AutoStore.

218
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Authentication Specifies which application performs the login
and which login method that it will use. See the
authentication option table below. The default
setting is Print Manager Authentication. Options
are:
• Print Manager Authentication with Device
Access Control
• Print Manager Authentication
• Device Authentication
• AutoStore Authentication
• External AAA Provider
• CAP
If you select Print Manager Authentication
with Device Access Control, Print Manager
Authentication, or AutoStore Authentication and
the Ricoh device has a Smart Operation Panel, set
SmartPanel Compatibility Mode to True.
For more information on the authentication modes
settings, refer to Ricoh authentication modes.

Secure Communication Enables secure socket layer (SSL)

communication. The default value is False. The
connection profile is HTTP when this is set to
False or HTTPS when this is set to True.
For Equitrac, this setting must be set to True.

Log Level The level of logging. There are four options:

• Error - Errors are displayed in the log.
• Warning - Errors and warnings are displayed in
the log.
• Information - Errors, warnings, and information
messages are displayed in the log.
• Debug - All message types as well as
debugging messages are displayed in the log.
The default is Debug and provides for the most
detailed logging.

219
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Smart Operation Panel Compatibility Mode Enables authentication compatibility between the
Nuance Combined Client for Ricoh and Ricoh
devices that have a Smart Operation Panel.
Set the value to True if the device has a Smart
Operation Panel and the Authentication value
is Print Manager Authentication with Device
Access Control, Print Manager Authentication, or
AutoStore Authentication. The Nuance Combined
Client for Ricoh shows a graphical Logout button
because the Smart Operation Panel does not have
a Logout key.
Set the value to False for Ricoh devices that do
not have a Smart Operation Panel. Users log out
by pressing the Logout key on the standard device
panel.

Print Manager Date Format The format used for dates displayed by the print
manager server.

Print Manager DateTime Format The format used for date and time displayed by
the print manager server.

AS Application Name The name of the application displayed on the

device panel. The default is AUTOSTORE
workflow.

AS Status Refresh Interval The refresh interval for AutoStore in seconds. The
default is 60 seconds.

AS Batch Scan Timeout When batch scanning mode is enabled, the period
of inactivity (in seconds) at the device panel before
the Nuance Combined Client for Ricoh sends the
batch scan job to AutoStore. For example, you
use the default of 60 seconds. If a user scans a
batch of 12 documents and leaves the device, the
Nuance Combined Client for Ricoh sends the job
to AutoStore 60 seconds after the last document
enters the scanner.

220
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Print Manager Application Timeout The period of inactivity (in seconds) at the device
panel before the Nuance Combined Client for
Ricoh automatically logs a user off the device.
On a device that operates with a Java platform
version older than 10.x, the period of inactivity
starts with a key or button click when the Nuance
Combined Client for Ricoh is active on the panel.
On a device that operates with Java platform
version 10.x or newer, the period of inactivity starts
with a key or button click from any application.
The default is 300 seconds.

Display Destination Specific Documents only If the option is set to True, the device only shows
the user's jobs that were sent to the specific
device. If this option is set to False, all of the
users print jobs show on a device, regardless of
where they were sent. The default is False.

Print Manager Enable SSO Provider Enables notification to SSO Provider of user login
and logout events when the print manager is the
login application. Enable this only when both the
following criteria exist:
• A third-party application requires SSO through
the UC login.
• The Nuance SSO Provider is installed.
The default is False.

Use SNMPv3 Use SNMPv3 for tracking print jobs (securely

communicating print counts, copy counts, and so
forth). To use this feature, you need to enable and
configure SNMPv3 functionality on a device.

Device Context Name Set this to match the SNMPv3 context name
setting configured on the device.

Account Name Set this to match the SNMPv3 account name

setting configured on the device.

Authentication Password Set this to match the SNMPv3 authentication

password (user) setting configured on the device.

Encryption Password Set this to match the SNMPv3 encryption

password (user) setting configured on the device.

221
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Authentication Algorithm Specifies the cryptographic hash function used to
protect authentication information.
• SHA1
• MD5

Encryption Algorithm Specifies the encryption algorithm used to encrypt

communications with a device.
• AES
• AES192
• AES256
• DES

Client Package Select a client package from this list. The selected
application package is downloaded to a device
by the Install action. List items are populated
by the uploaded files specified on the Files tab.
Ricoh ESA installation packages are downloaded
from the Equitrac Partner Portal or from the Web
Licensing Portal. For information about how to
add a Ricoh ESA installation package to DRS, see
Files tab on page 222.

Files tab
Download the installation package in ZIP format from the Equitrac Partner Portal or from the Web
Licensing Portal and upload all of these files to Device Registration Service to create the groups:
1. Open DRS and click on Files tab to open files upload window.
2. For the Device Type, choose Ricoh ESA.
3. Click the upload green button at the bottom of the screen and upload the 33956099.zip or
34084353.zip file.
Alternatively, you can copy these client packages zip files to the following Device Registration
Service plugin folder: C:\Program Files (x86)\Nuance\Device Registration Service
\Service\Plugins\NSi.DeviceManagement.Plugins.Ricoh.
4. After file upload, navigate to Devices tab and choose client package when configuring device
settings.

Ricoh authentication modes

The following table describes the authentication modes that you can use for a Nuance Combined Client
for Ricoh device or device group.

222
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Mode Description

Print Manager Authentication with Device The print manager server manages authentication.
Access Control The print manager controls login and logout
protocols on the device for the Nuance Combined
Client for Ricoh. All device functions such as
copying and faxing are made available only after
the user logs into the device. Login at the device
will be by user name and password credentials,
PIN, or a card used that can be swiped at the
device.
Accounting which encompasses the tracking of the
number of printing, copying, scanning and faxing
jobs is enabled.
Once logged in, the user can toggle between
AutoStore and the print manager if both
functionalities are enabled for the device profile.
The initial application that appears after login is
controlled by the Default Functionality property.
Configure a device for external authentication
provides more information on the Print Manager
Authentication with Device Access Control
option.

Print Manager Authentication The print manager (Equitrac or Output Manager)

manages authentication. The print manager
controls login and logout protocols on the device
for the Nuance Combined Client for Ricoh only.
Other device functions such as copying and faxing
are not affected. The user provides user name and
password login credentials at the device or swipes
a card at the device.
Once logged in, the user can toggle between
AutoStore and the print manager if both
functionalities are enabled for the device profile.
The initial application that appears after login is
controlled by the Default Functionality property.

223
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Mode Description
Device Authentication The device manages authentication. The internal
authentication component of a device controls
login and logout protocols. The print manager
controls access to the Nuance Combined Client
for Ricoh. The user provides user name and
password login credentials at the device or swipes
a card at the device.
Once logged in, the user can toggle between
AutoStore and the print manager if both
functionalities are enabled for the device profile.
The initial application that appears after login is
controlled by the Default Functionality property.
Configure a device for internal authentication
provides more information on the Device
Authentication option.

AutoStore Authentication AutoStore manages authentication.

The Ricoh ESA component in AutoStore supports
Microsoft Windows, Active Directory, NetWare,
and custom scripting authentication types.
Once logged in, the user can toggle between
AutoStore and the print manager if both
functionalities are enabled for the device profile.
The initial application that appears after login is
controlled by the Default Functionality property.
To complete AutoStore Authentication, refer to the
Ricoh ESA component Help in AutoStore for more
information.

224
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Mode Description
External AAA Provider Adaptable Authentication API (AAA) is a sign-on
(SSO) infrastructure used by Ricoh to manage
authentication.
The print manager or AutoStore can control
access to the Nuance Combined Client for Ricoh.
If the Enable Print Release and Enable Scan
values are True and the Default Functionality
value is AutoStore, AutoStore controls access
to the Nuance Combined Client for Ricoh. If the
Enable Print Release and Enable Scan values
are True and the Default Functionality value
is Print Manager, then the print manager server
controls access to the Nuance Combined Client
for Ricoh.
Users log in at the device with a common access
card (CAC). For AutoStore, other options can
include third-party applications. These applications
must be installed prior to using this option.
Once logged in, the user can toggle between
AutoStore and the print manager if both
functionalities are enabled.

CAP Card Authentication Package (CAP) is a card

login product used by Ricoh to manage card
authentication.
The print manager or AutoStore can control
access to the Nuance Combined Client for Ricoh.
If the Enable Print Release and Enable Scan
values are True and the Default Functionality
value is AutoStore, AutoStore controls access
to the Nuance Combined Client for Ricoh. If the
Enable Print Release and Enable Scan values
are True and the Default Functionality value is
Print Manager, then the print manager controls
access to the Nuance Combined Client for Ricoh.
Users log in at the device with CAP. CAP must be
installed prior to using this mode of authentication.
Once logged in, the user can toggle between
AutoStore and the print manager if both
functionalities are enabled.

Note: When the print manager is Output Manager, the Output Manager detailed history by device
report shows entries for native copy, Output Manager print, and AutoStore scan jobs. The report does
not show entries for native scan and fax jobs.

225
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Device Registration Service Action properties

This topic lists properties of a Device Registration Service action, which are configured in the Device
Registration Service.

Property Description

Name Device profile name. This is read only.

Address IP address of the device.

Serial Number Serial number of the device. This is read only.

Username User name used to connect the device. The

default is admin.

Password Password to connect the device. The default is

ricoh.

Connection profile This is either HTTP or HTTPS, depending on the

Secure Communications setting in the Ricoh ESA
device parameters.

Status codes
You may see the following status codes when applying an action in the Device Registration Service.
These codes show for items in the Action History.

Return Code Description

0 Xlet is not installed.

100 Xlet is installed.

200 Xlet is initializing.

300 Xlet has started.

350 Xlet has stopped.

370 Xlet has paused.

390 Xlet is inactive.

500 Xlet status cannot be determined.

226
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Combined Client for Ricoh actions reference

Actions that can be performed from the Device Registration Service for a Nuance Combined Client for
Ricoh device.
To perform an action, first select a device on the Device tab in the Device Registration Service web
console. Then, in the box at the top of the Details pane, click an available action to perform on the

device and click the run button .

Action Description

Start Starts the Nuance Combined Client for Ricoh on

the device.

Stop Stops Nuance Combined Client for Ricoh on the

device.

Install Installs the Nuance Combined Client for Ricoh on

the device.

Uninstall Uninstalls the Nuance Combined Client for Ricoh

on the device.

Update Menus Updates device registration configuration and

menus for the AutoStore application on the device.

Reboot Restarts the device.

Install and Start Installs the Nuance Combined Client for Ricoh on
the device and then starts the Nuance Combined
Client for Ricoh.

Install and Reboot Installs the Nuance Combined Client for Ricoh on
the device and then restarts the device.

Import guidelines
This topic provides guidelines for importing Nuance Combined Client for Ricoh device information into
Device Registration Service with a comma separated values (CSV) file.

Header information
The first row in the CSV file is the header row that contains header values for device information.
Header values appear in the following order: Name, IP, ApplicationProfile, DeviceType,
DeviceGroup, Properties, InheritPropertyFromGroup, SerialNumber, Username,
Password. The subsequent rows list the corresponding values for each device separated by commas.
Use the same header row when importing devices for all unified or combined client types.
The first row must always contain the header row, because Device Registration Service uses the
headers to identify imported values. In subsequent rows, you can omit values other than those that

227
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

correspond to Name, IP, and ApplicationProfile. If you omit a value, make sure to insert the
comma delimiter that corresponds to the value.

Nuance Combined Client for Ricoh properties

When you add a property to the file, do not include a space in the property name. The following table
describes the properties that you can include in the file:
Note: An asterisk indicates a required property.

Property Description

EnablePrintRelease (*) Set to True to enable users to release print

manager print jobs after logging in to the
device. The default value is True.

EnableScan (*) Set to True to enable users to scan

documents through AutoStore. The default
value is True.

DefaultFunctionality (*) Specifies the default functionality for the

client. Options are:
• Print Manager
• AutoStore

Authentication (*) Determines the authentication mode. Options

are:
• Print Manager Authentication with
Device Access Control
• Print Manager Authentication
• Device Authentication
• AutoStore Authentication
• External AAA Provider
• CAP
Ricoh authentication modes provides more
information on authentication modes.
If you select Print Manager Authentication
with Device Access Control, Print
Manager Authentication, or AutoStore
Authentication and the device has a
Smart Operation Panel, set SmartPanel
Compatibility Mode to True.

228
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description

SecureCommunication Set to True to enable secure socket layer

(SSL) communication through HTTPS. Set
to False to use unsecured communication
through HTTP. The default value is False.

LogLevel (*) The level of logging. There are four options:

• Error: Errors appear in the log file.
• Warning: Errors and warnings appear in
the log file.
• Information: Errors, warnings, and
information messages appear in the log
file.
• Debug: All message types and debugging
messages appear in the log file.
The default is Debug and provides for the
most detailed logging.

OMDateFormat Specify the format that the print manager

uses to the show date.

OMDateTimeFormat Specify the format that print manager uses to

show the date and time.

ASApplicationName Specify the name of the application that

appears on the device panel.

ASStatusRefreshInterval Specify the refresh interval for AutoStore in

seconds. The default is 60 seconds.

ASBatchScanTimeout When batch scanning mode is enabled,

specifies the period of inactivity in seconds
at the device panel before the Nuance
Combined Client for Ricoh sends the batch
scan job to AutoStore. For example, you use
the default of 60 seconds. If a user scans
a batch of 12 documents and leaves the
device, the Nuance Combined Client for
Ricoh sends the job to AutoStore 60 seconds
after the last document enters the scanner.

229
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description

OMApplicationTimeout Specify the period of inactivity in seconds

at the device panel before the Nuance
Combined Client for Ricoh automatically
logs a user off the device. The default is 300
seconds.
On a device that operates with a Java
platform version older than 10.x, the period
of inactivity starts with a key or button click
when the Nuance Combined Client for Ricoh
is active on the panel. On a device that
operates with Java platform version 10.x or
newer, the period of inactivity starts with a
key or button click from any application.

DisplayDestinationSpecificDocumentsOnly Set to True to show print jobs for only the

device that you are configuring. For example,
you set the value to True for device A.
When users view print jobs at the device
A panel, they see only the print jobs that
they have submitted to device A. If the value
is False, users see the print jobs that they
have submitted to device A and to other
destinations.
The default is True.

OMEnableSSOProvider Set to True to enable single-sign-on (SSO)

through a provider if users log in and
log out through a device configured for
print manager functionality. Verify that the
following requirements are satisfied to enable
SSO:
• A third-party application wants SSO
through the Nuance Combined Client for
Ricoh login.
• A Nuance Communications SSO provider
is installed.
The default is False.

230
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description

SmartPanelCompatibilityMode Enables authentication compatibility between

the Nuance Combined Client for Ricoh and
Ricoh devices that have a Smart Operation
Panel.
Set the value to True if the device
has a Smart Operation Panel and the
Authentication value is Print Manager
Authentication with Device Access Control,
Print Manager Authentication, or AutoStore
Authentication. The Nuance Combined Client
for Ricoh shows a graphical Logout button
because the Smart Operation Panel does not
have a Logout key.
Set the value to False for Ricoh devices that
do not have a Smart Operation Panel. Users
log out by pressing the Logout key on the
standard device panel.

Sample import file

The following example shows Ricoh import file entries:

Nuance Combined Client for Ricoh return codes

Nuance Combined Client for Ricoh return codes appear for device actions that you perform through
Device Registration Service.
The following return codes appear in the Action History.

Return Code Description

0 Xlet is not installed.

100 Xlet is installed.

200 Xlet is initializing.

300 Xlet has started.

350 Xlet has stopped.

370 Xlet has paused.

231
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return Code Description

390 Xlet is inactive.

500 Xlet status cannot be determined.

Restrictions and limitations

Short reference description.

Restriction or limitation Category Comments

Limited tracking of job attributes Equitrac reporting Attributes for jobs tracked from
the client are limited compared
to other (non DRS) clients. Job
costing will be correspondingly
restricted.
• No finishing options reported
(stapling, binding, folding,
etc).
• No media type or tray
information reported.
• Scan destination not reported.
• Fax destination/number not
reported.
• Sent vs received fax not
distinguished.

Page sizes not reported. Equitrac reporting Page sizes are generally not
reported.

Page size usually reported as Equitrac reporting If page sizes are included for
unspecified reporting, they are sent as
“regular” or “large”. These are
arbitrarily mapped to A4 and A3
respectively.

CAC/SmartCard support Equitrac User identifier reported by the

external system, if not in UPN
format with a valid domain,
must be added as a primary or
alternate primary PIN in Equitrac

Billing code limit on client Equitrac Billing codes available on client

are limited to 10,000.

232
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Restriction or limitation Category Comments

Scan workflows not available Equitrac Equitrac scan workflows are not
available.

No external application support Equitrac

No guest user support Equitrac

No release key support Equitrac

Cannot use page size limits Equitrac Client (or DWS) enforced limits
and quotas cannot use page size
when evaluating limits/usage.

Troubleshooting the Nuance Combined Client for Ricoh

This topic provides information for troubleshooting problems with the Nuance Combined Client for Ricoh
application.

Error codes

Table 4: Nuance Combined Client for Ricoh error codes

Code Description

J201, J301 Failed security check due to:

• A demo signature expired.
• Corrupted device registry information when a
device was not shut down properly.
Uninstall and reinstall the application.

J204 Disk out of space for one of the following reasons:

• Failed to copy application zip file to the install
directory.
• Cannot start in standard time due to missing
file, wrong .dalp file format, or thread takes
too long.

J522 Java class reference missing for one of the

following reasons:
• Missing library.
• An application exception.
• For a 10.x device, this can occur when
installing with Web Image Monitor. You can use
RxopGuiClient instead of Web Image Monitor.

233
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

A4 small panel scanner settings

Typically, the MFP device automatically detects the scan settings that you configure. If the MFP device
does not detect the scan settings and the device panel shows an error, map the device model code to
the scanner bed value:
1. Locate the 33956099.zip file on the server (for example, C:\Program Files (x86)\Nuance
\Device Registration Service\Service\Plugins\33956099.zip).
2. Extract the modelinfo.properties file from the ZIP file and open it in a text editor.
3. Configure the properties file by adding an entry for your device in the following format:
Modelcode=ScanSize
4. Save your changes to the file and reinstall the Xlet.

234
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for

Ricoh Smart Operation Panel

Overview of the Nuance Unified Client for Ricoh Smart

Operation Panel
The Nuance Unified Client for Ricoh Smart Operation Panel provides a unified client for capture and
print manager functionality on Ricoh SOP multifunction printers (MFPs). Your business requirements
determine capture and print manager requirements for your environment. Embedded on the MFP,
Nuance Unified Client for Ricoh Smart Operation Panel controls access to the MFP, and acts as the
gateway for Nuance functionality. Users must authenticate to gain access to Nuance-controlled device
functions.
Use Device Registration Service to deploy embedded client on Android-enabled devices and configure it
to either or both capture and print on a client. Capture (with process and route) functionality is supported
by Nuance AutoStore, while print management may be supported by either Nuance Equitrac or Nuance
Output Manager.
The following figure illustrates the architecture for a system that includes the Nuance Unified Client for
Ricoh Smart Operation Panel :

235
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 33: System architecture with Nuance Unified Client for Ricoh Smart Operation Panel

The Nuance Unified Client for Ricoh Smart Operation Panel provides device authentication with a
single application for Equitrac Follow-You Printing and scanning into AutoStore workflows. This client
secures access to devices, allows user to toggle between Follow-You Printing and scanning, provides
card reader support, searchable billing codes at device login, and job accounting.
The Nuance Unified Client for Ricoh Smart Operation Panel supports AutoStore, Equitrac, and Output
Manager authentication through user name and password, card identification (ID) with an optional
personal identification number (PIN), and card swipe with an optional PIN.
The Nuance Unified Client for Ricoh Smart Operation Panel supports single sign-on (SSO) for the
following systems:
• Adaptable Authentication API (AAA): Ricoh SSO infrastructure.
• Internal authentication: built-in MFD logon mechanism.
• Card Authentication Package (CAP): Card logon product from Ricoh.
The Nuance Unified Client for Ricoh Smart Operation Panel can collect accounting data to enable you
to track usage for up to three billing accounts.

Checklist: Nuance Unified Client for Ricoh Smart Operation

Panel implementation
This implementation check list covers aspects deploying the Nuance Unified Client for Ricoh Smart
Operation Panel to devices from the Device Registration Service web client.
This checklist should evolve based on the experience you gain from performing deployments. You might
also want to perform custom checks that are based on a specific aspect of your network architecture or
environment.

236
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Table 5: Unified Client Deployment Checklist

Check Description See

Confirm that your system meets • Nuance Unified Client for

requirements. Ricoh Smart Operation Panel
system requirements on page
238

For AutoStore capture • Ricoh SOP component

functionality, configure the Ricoh help in AutoStore Process
SOP in an AutoStore workflow Designer.
using the AutoStore Process
Designer.

To use Equitrac as the Print • Server Side Configuration on

Manager, configure the Ricoh page 263
PCC5 embedded type on the
Equitrac server.
Note: If you are deploying
a large fleet of devices, we
recommend that you apply
the typical embedded
licenses for the devices
before installing the
embedded application.
Otherwise, the software
can be licensed after the
application is installed on
the device. See Licensing
Nuance Unified Client for
Ricoh Smart Operation
Panel on page 263

To use Output Manager as the • Output Manager

Print Manager, configure the Administration Guide
Ricoh SOP embedded device
type in Output Manager.

Download the client installation • Working with client packages

package from the Equitrac on page 18
Partner Portal or from the Web • How to upload a Unified
Licensing Portal and add it to the Client installation package to
DRS server. DRS on page 20

Add a DRS application for • Add an application

Nuance Unified Client for Ricoh • Application properties on
Smart Operation Panel . page 295

237
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description See

Add or import a Nuance Unified • How to add a new Device

Client for Ricoh Smart Operation profile on page 13
Panel device. • How to import Device
Note: Ensure you have information on page 15
administrator credentials • Nuance Unified Client for
to access all MFPs where Ricoh Smart Operation Panel
the client is deployed. device properties on page
298

Install, uninstall, configure, or • Nuance Unified Client for

restart Nuance Unified Client for Ricoh Smart Operation Panel
Ricoh Smart Operation Panel . actions reference on page
304

Nuance Unified Client for Ricoh Smart Operation Panel system

requirements
The following table describes system requirements for the Nuance Unified Client for Ricoh Smart
Operation Panel .

Component Requirement
AutoStore Version 7.0 SP1 Patch 1 or later

Equitrac Equitrac Office or Equitrac Express version 5.6 with all available hotfixes installed, or
later

Output The following is required it print management with Output Manager is enabled in
Manager Device Registration Service.
• Build 4.0 SP1
• OM Device configured with:
• Embedded client type set to Ricoh SOP
• Unified client option is selected
• OM Destination associated with the OM Device with the correct printer family
definition.
• Destination Group with Pending Queue.
• OM Source Output Setting configured to Route to the Pending Queue.

238
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Component Requirement
Languages Nuance Unified Client for Ricoh Smart Operation Panel interface includes support for
the languages listed below. The language is selected automatically based on the MFP
language. If the MFP language is not available, English is used by default.

• Simplified Chinese • Finnish • Norwegian

• Traditional Chinese • French • Polish

• Catalan • German • Portuguese

• Czech • Hungarian • Russian

• Dutch • Italian • Spanish

• Danish • Japanese • Swedish

• English • Korean • Thai

Note: The list of languages available on the client does not necessarily match
languages available on the administrative web client.

Card readers The Nuance Unified Client for Ricoh Smart Operation Panel supports Equitrac USB
external card readers and Ricoh-supported third-party card readers.
For the current list of Equitrac supported card formats, refer to the Equitrac ID Card
Reader Product Specs page on the Nuance web site.

Supported • Nuance Supported Device Search: Ricoh

devices

How to configure the SSL/TLS certificates

Before performing any Device Registration Service (DRS) actions, it is recommended that you verify the
following SSL/TLS certificate configuration on the MFP. After installing DRS 7.9 patch 2, these steps are
required.
1. Verify that the device certificate is installed and the SSL/TLS certificate is specified.
a) On the Web Image Monitor application, open Device Management > Configuration >
Security > Device Certificate.
b) If the SSL/TLS certificate is not selected, select it.

239
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

c) Click OK.
2. Verify that the Ciphertext Priority option is selected.
a) On the Web Image Monitor application, open Device Management > Configuration >
Security > Device Certificate.
b) In the Permit SSL/TLS Communication field, select Ciphertext Priority.

240
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: To use Ricoh configuration tools, you must select at least one of the following options:
TLS1.2, TLS1.1, or TLS1.0.

c) Click OK.

Configuration requirements when deploying the client with third-party

authentication
How to modify the DRS configuration file to deploy devices with third-party
authentication
To install the client in a device using third-party authentication, such as CAC, you must modify the
configuration file for Device Registration Service (DRS).
1. Go to the C:\Program Files (x86)\Nuance\Device Registration Service\Service
\Plugins folder.
2. Open the NSi.DeviceManagement.Plugins.RicohSOP.dll.config file in a text editor.
Note: You must have administrator permissions to save your changes.

3. Change the value for SkipAdditionalInstall to true.

4. Save the configuration file.
5. Restart the DRS Service from the DRS Configuration Manager tool.
6. With this change, the Ricoh device must be manually rebooted after you run the Config and Reboot
device action.

241
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: You must reboot the device manually, and not from the Web Image Monitor or using the
Reboot action in DRS.

Baseline device property configuration

The baseline device property must always be set to False when deploying to an MFP that has third-
party authentication enabled. If this property is set to True, then it will cause the client installation and
configuration to override settings required by the third-party authentication.
Note: If you are editing an existing device that was not previously configured with third-party
authentication and you do not see a field called Baseline Installation, click Edit for your existing
device and then Save to display the field.

Configuring Nuance Unified Client for Ricoh Smart Operation

Panel
This section documents how to configure Output Manager, AutoStore, and Equitrac to use with the
Nuance Unified Client for Ricoh Smart Operation Panel .
Important: Specific Ricoh device settings vary by geographic location and setup. Please consult your
Ricoh technician for any MFP-specific settings needed for your particular deployment.

Configure Output Manager

This section describes how to configure Output Manager for use with Nuance Unified Client for Ricoh
Smart Operation Panel on supported multifunction printers (MFPs). In addition to this guide, ensure that
you have any documentation related to Output Manager product suite, documentation for your MFP, and
the DRS user and installation guides.

How to configure the SSL port

Follow the steps in this procedure to configure the Output Manager SSL port for the Nuance Unified
Client for Ricoh Smart Operation Panel .
1. On the Output Manager machine, select Start > All Programs > Output Manager Server > OM
Server Configuration .
2. Click the SSL Certificate Manager tab and configure the port for DdmInterface.

242
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Click Help for more information on configuring SSL settings.

How to configure Output Manager devices

This topic describes how to configure devices in the Output Manager Console.
1. On the Output Manager server, select Start > All Programs > Output Manager > Output Manager
Console > Output Manager Console and connect to the Output Manager server.
2. In the Devices application, right-click the device and select Configure.
3. Click the Device Details tab.
4. For Embedded client type, verify that Ricoh SOP is selected.
5. Configure devices for accounting, and then complete the following steps:
a) Enable Output Manager login for Nuance Unified Client for Ricoh Smart Operation Panel .
b) Set Manage login in Output Manager to External.
6. Configure devices for access control.
7. Configure devices for print preferences.
8. Configure devices for login methods.
9. Configure devices for billing accounts.
10.Configure user copy quotas for devices.

How to configure device for accounting

This procedure describes how to configure a device for accounting.
If the Device Configuration dialog box for the device is not open already, follow the instructions in
Configure Output Manager devices before continuing with this procedure.

243
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Accounting data for Output Manager print jobs and the Nuance Unified Client for Ricoh Smart
Operation Panel scan jobs is always recorded, regardless of settings configured with this procedure.

1. In the Device Configuration dialog box, click the Device Details tab.
2. For Cost Management, select Prints or Copies depending on your business requirements.
3. If you selected Copies, specify the cost per page.
If the Nuance Unified Client for Ricoh Smart Operation Panel is already started, restart it to implement
the changes.

How to configure device for access control

This procedure shows how to create access control profiles for users, groups, and departments.
If Device Configuration dialog box for the device is not open already, follow instructions in Configure
Output Manager devices before continuing with this procedure.
Perform these steps only if access control is required.
Access control can be configured for users, groups, and departments. If access control is not
configured, a default profile with full access is provided for new users.
1. In the Device Configuration dialog box, click the Device Details tab.
2. Select Unified client.
3. In the Unified Client box, click Configure access control.
4. Click the appropriate tab to configure access control for Users, Groups, or Departments.
5. Click the browse button (...) for the user, group, or department that you want to configure.

6. In the Manage MFP ACL Profiles dialog box, you can create or edit ACL profiles for the selected
user, group, or department.

244
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. Click New to create an MFP ACL profile.

You do not need to restart the Nuance Unified Client for Ricoh Smart Operation Panel to implement
the changes. The changes take effect the next time users log in to the Nuance Unified Client for
Ricoh Smart Operation Panel .

How to configure device for print preferences

MFP Kiosk Preferences profiles make print preference available to users.
If Device Configuration dialog box for the device is not open already, follow instructions in Configure
Output Manager devices before continuing with this procedure.
Perform these steps only if you want users to adjust print preferences before printing.
1. In the Device Configuration dialog box, click the Device Details tab.
2. Select Unified client.
3. In the Unified Client box, click New.
4. Type a name for the profile in the Name field.
5. Optional: Type a profile description in the Description field.
6. Click the arrow next to any item to expand an option group.
7. Select the check box next to a print option to add it to the Selected items list.

8. Click OK.
If the Nuance Unified Client for Ricoh Smart Operation Panel is already started, restart it to implement
the changes.

245
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure sign-in methods

This procedure describes how to configure the sign-in methods for Output Manager users.
1. Start the Output Manager console and connect to the server.
To start the console, select Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application.
3. In the Administration options, click Set General Preferences.
4. In the Administration - Set General Preferences settings, click the Security tab.

5. Select options in the External client login section as described in the following table:

Option Description
Allow user name / password The user can log in by entering user name,
password, and selecting a domain.

Allow card swipe The user can log in through a card swipe. The
user must also enter a PIN if Require PIN with
card swipe is selected.

Allow manual card ID entry The user can log in by entering an ID. The
user must also enter a pin if Require PIN with
manual entry is also selected.

Allow unmasked card ID The card ID will be readable as it is entered.

If you clear this check box, the card ID will be
masked.

Default manual login method Select the default user login method:
• Card ID Entry
• User Name/Password

246
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Require PIN with card swipe Users must also enter a pin when using a card
swipe.

Require PIN with card ID entry Users also enter a PIN when using manual card
ID entry.

6. Click Apply.
7. Restart Output Manager.

How to configure billing accounts

This procedure describes how to configure billing accounts and scan properties for Output Manager
users.
1. Start the Output Manager Console and connect to the server.
To start the console, click Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application.
3. In the Administration options, click Manage Billing Accounts.
4. In the Administration - Manage Billing Accounts settings, you can create or edit a billing list and
its billing accounts.

5. You can create secondary billing accounts under the main accounts.

247
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

The following steps associate the billing lists to users:

6. Click the Administration application again, and in the Administration options, click Manage Users.
7. In Administration - Manage Users, select a user and click the Device Profile column to select or
edit an existing profile or to create a new profile.

8. In a profile, you can create a single billing list, two billing lists, or one primary list and one secondary
list.

248
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

9. Click OK.
You do not need to restart the Nuance Unified Client for Ricoh Smart Operation Panel . Users see the
changes after their next login.

How to configure copy quotas

This procedure describes how to configure the copy quota for a user.
1. Start the Output Manager Console and connect to the server.
To start the console, click Start > All Programs > Output Manager > Output Manager Console >
Output Manager Console.
2. Click the Administration application button.
3. In the Administration options, click Manage Users.
4. In the Administration - Manage Users pane, click the Balances tab.

249
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. For a user, select the check box in the Set Balance column, and click the browse button (...) in the
Allowances Profile column to create or edit profiles.

6. Click New or Edit to set allowances for print and copy.

7. Click OK to save changes to the profile and then click Close.

8. Click the profile list the Allowances Profile column to assign the allowances profile to the user.

You do not need to restart the Nuance Unified Client for Ricoh Smart Operation Panel . Users see the
changes after their next login.

250
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Accounting
The Nuance Unified Client for Ricoh Smart Operation Panel uses accounting flags to perform
accounting operations. Collecting accounting data is achieved through the following actions:
• Output Manager server tracks print activity.
• Output Manager server tracks AutoStore scan activity.
• Print and native copy activities are tracked according to the accounting flags. AutoStore scan
activities are also tracked.
The Nuance Unified Client for Ricoh Smart Operation Panel records accounting data for color and black
and white content as follows:
• When a user logs in at a device, the Nuance Unified Client for Ricoh Smart Operation Panel reads
the device print and copy counters. When the user logs out, the Nuance Unified Client for Ricoh
Smart Operation Panel reads the counters and records the differences since the start of the session.
• The Nuance Unified Client for Ricoh Smart Operation Panel records data for configured billing
accounts. When the user changes the billing accounts while logged in, the Nuance Unified Client for
Ricoh Smart Operation Panel records the counter differences before each change.
• For an Output Manager print job, the Output Manager server records its accounting data at the end
of the job regardless of the accounting settings. The Output Manager server uses the recorded print
counters to reconcile the accounting data.
• For an AutoStore scan job, the Nuance Unified Client for Ricoh Smart Operation Panel records its
accounting data at the end of the job regardless of the accounting settings.

Enable quota management

This topic describes how to enable quota management on a device.
Configure the following to have Output Manager to use quota management:

Do this See
Enable external authentication How to configure sign-in methods on page 246
Set manageLogin to external Login settings on page 252
Set the allowance profile Configure copy quota for users

Note: Output Manager cannot provide quota management on 2.x devices, as they do not support
external authentication.

Quota is checked at login time, and during and after a copy session. After the limit is reached, the
Nuance Unified Client for Ricoh Smart Operation Panel issues a command to stop copy. The command
turns off all device functions, including copy, scan, and fax. Depending on the device capabilities, it may
continue copying pages before its functions are turned off. The Nuance Unified Client for Ricoh Smart
Operation Panel may then prompt for a key card and the Print Manager will prompt that the quota has
been reached.

Typical usage
This section describes how to configure Output Manager for use with Nuance Unified Client for Ricoh
Smart Operation Panel on supported multifunction printers (MFPs) and configure the product for initial
start-up. In addition to this guide, ensure that you have any documentation related to your Output
Manager product suite, documentation for your MFP, and the DRS User Guide.

251
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: This guide assumes that you are installing the Equitrac products (servers and embedded
applications) in a Windows network environment. This guide does not provide any information for
third-party software (including databases) or operating system support.
Output Manager login
This section describes how to configure login settings and how to log on to Output Manager through the
Nuance Unified Client for Ricoh Smart Operation Panel .
Login settings
This topic describes settings that control the Nuance Unified Client for Ricoh Smart Operation Panel
login to Output Manager.
The Nuance Unified Client for Ricoh Smart Operation Panel login is configured in the Output Manager
Console by the External client login options (see Configure logon methods).

The External client login The settings define three login methods and two PIN options:
• User name and password login.
• Card swipe login, with optional PIN.
A PIN can be treated as password for a card ID.
• Manual card ID entry login, with option for a PIN.
After you change login settings on the Output Manager server, restart the Nuance Unified Client for
Ricoh Smart Operation Panel to implement the changes. Depending on the selections in the External
client login settings, users see different login options at the Nuance Unified Client for Ricoh Smart
Operation Panel .
Typically, all three login methods are enabled. Depending on the default login method selected at the
Output Manager server, the user sees either the user name and password login or the manual card ID
entry login.

252
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 34: User name/password login screen

Figure 35: Manual ID entry login screen

The user name, password, and card ID or PIN are entered using a soft keyboard.

253
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 36: Soft keyboard

When the Allow unmasked card ID check box is cleared, the entry is obscured as the user types
characters.

Figure 37: Soft keyboard with mask

User name and password entry

This section describes options when supplying a user name and password to log in.
User name and password entry supports the following user types:
• Microsoft Windows domain
• Output Manager
• LDAP realm
The domain, Output Manager, or realm is selected in the Domain list box:

254
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Card swipe
This topic describes options for the card swipe login.
This login type supports the following features:
• Card can be swiped when the Nuance Unified Client for Ricoh Smart Operation Panel is not the
active application on the device panel. The Nuance Unified Client for Ricoh Smart Operation Panel
performs a login in the background. This is very helpful when the Nuance Unified Client for Ricoh
Smart Operation Panel is providing SSO to other applications. The active application could log in the
user after receiving the SSO notification.
• Card can be swiped when the device is in energy-saving sleep mode. The Nuance Unified Client for
Ricoh Smart Operation Panel wakes up the device and logs in the user.
If the Require PIN with card swipe option is not selected, the card swipe logs in a user with a
registered card ID. If the Require PIN with card swipe option is selected, the user enters a PIN.

If a login fails, the Nuance Unified Client for Ricoh Smart Operation Panel prompts the user to register
an ID or PIN, and if the assignment is successful, the user can use the newly card ID or PIN for future
logins.

255
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Manual ID entry
This section describes options for the manual ID entry login.
Manual ID entry login prompts for both ID or server or registers an unrecognized user. By default, the
manual ID login provides fields for both card ID and PIN for logging onto the server. If the PIN option is
disabled, the Nuance Unified Client for Ricoh Smart Operation Panel shows the login screen without
the PIN field.

If a login fails, the Nuance Unified Client for Ricoh Smart Operation Panel prompts the user to register
an ID or PIN.
If the user presses Yes, the Nuance Unified Client for Ricoh Smart Operation Panel prompts the user to
log in to assign an ID or PIN.
If the assignment is successful, the user can use the card ID or PIN for future logins.
Screen layout
After a user logs in, the Nuance Unified Client for Ricoh Smart Operation Panel shows the AutoStore
workflow or the Print Manager screen.
The Nuance Unified Client for Ricoh Smart Operation Panel screen that appears depends on the
settings that you configure in How to add a new Device profile on page 13.

256
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 38: AutoStore workflows on device panel

View Print jobs

The printed jobs lists show information about completed print jobs.
The user can view and manage jobs in the Output Manager Follow-You Printing jobs list.

Figure 39: Output Manager job screen

Users can set Copies and configure color options above the job list. Printed jobs are shown as
[Retained].

Button Description
Print Prints the selected job in the list.

Changes the number of copies of a document to

Copies print.

257
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Button Description

Configures color options.

View Job information

The Follow-You Printing screen shows the number of documents currently selected and total page
count for the selected documents.

Figure 40: Job Information screen

Logout
The Nuance Unified Client for Ricoh Smart Operation Panel supports the following logout options at the
MFD:
• Logout button
• Logout by card swipe
• Auto logout
• Energy Saving Mode logout
• Powered off logout

Logout button
To end a user session and log out of Nuance Unified Client for Ricoh Smart Operation Panel , press the
Logout button on the top bar.

258
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Logout by card swipe

While logged in, the user can swipe a card again to log out. This is a convenient way to log out when the
application is not the current application on the panel, even for pre-10.x devices.

Auto logout
If the user forgets to log out, the Nuance Unified Client for Ricoh Smart Operation Panel automatically
logs out the user after the user has not been active on the MFD control panel for a specified time-
out interval. The time period is specified as the number of seconds through the Server Connections
Timeout property in the device Details pane in Device Registration Service (for more information, see
Nuance Unified Client for Ricoh Smart Operation Panel device properties on page 298).

Energy Saving Mode logout

When the device enters Energy Saving Mode while the user is logged in, the Nuance Unified Client for
Ricoh Smart Operation Panel logs out the user before the device shuts down.

Powered off logout

When the device is powered off manually or through auto-power off timer, the Nuance Unified Client for
Ricoh Smart Operation Panel logs out the user before the device shuts down.

Configure AutoStore
Add the Ricoh SOP component to an AutoStore workflow to provide capture functionality for Ricoh
devices with the Nuance Unified Client for Ricoh Smart Operation Panel . When you create the
DRS application, specify the AutoStore server address as well as the port number specified on the
Preferences tab of the AutoStore component configuration.
For details about configuring the Ricoh SOP component in AutoStore, refer to the component help in
AutoStore Process Designer.

Configure Equitrac
The Nuance Unified Client for Ricoh Smart Operation Panel provides copy control, scanning, and
secure printing on specific Ricoh manufactured multi-functional products (MFPs). Embedded on the
MFP, Nuance Unified Client for Ricoh Smart Operation Panel controls access to the MFP, and acts
as the gateway for Nuance functionality. Users must authenticate to gain access to Nuance-controlled
device functions.
Nuance Unified Client for Ricoh Smart Operation Panel communicates with Nuance servers and tracks
User activity. During a user session, MFP activity is captured.
Nuance Unified Client for Ricoh Smart Operation Panel requires Smart Operations Panel G2 or later.

Nuance Unified Client for Ricoh Smart Operation Panel Features

Nuance Unified Client for Ricoh Smart Operation Panel supports the following features:

Authentication Requires users to enter valid authentication

information to unlock the MFP functions. Users
can enter their authentication data via the MFP
panel, or by using a valid authentication card
(when authentication cards are implemented).

259
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Follow-You Printing® After successful login at the MFP, the user can
access the virtual print queue to "pull" a print job
to this device. Through the Follow-You screen on
the MFP, users can see a list of documents in the
queue, then select, delete, or release documents
for printing. See Enabling Secure Printing for
configuration instructions, and Using Follow-You
Printing or end-user instructions.
Scan-to-Me® Allows users to scan a document and email it
to their own address, and optionally to other
addresses via the CC field (if enabled). Users
can specify scan options (for example: duplex,
color, size) and document format prior to initiating
a scan. See Configuring Capture and Send for
configuration instructions, and Scanning for end-
user instructions.
Capture and Send capability Allows SOP to use third-party applications to scan
to multiple scan destinations through the Scan
Processing Engine (SPE). Currently, SOP allows
SharePoint (Teamsite) to scan to a web-based
location, and RightFax to scan directly to a Fax
number.
Card self-registration Allows users to associate an unassigned card with
their user credentials. Once associated, each time
the user swipes the card, the system automatically
recognizes the card and associated user. See
Configuring Card Self-Registration or instructions.
Billing Code support Users can change their jobs to a particular code,
and the Equitrac Office/Express database tracks
the characteristics of jobs changed to the code.
Billing codes must be enabled on the Equitrac
server. See Enabling the Billing Code Prompt and
also refer to the Creating & Managing Accounts
chapter in the Equitrac Office or Equitrac Express
Administration Guide.
Campus card support When enabled on the Equitrac Express server,
campus card payment systems including
Blackboard UNIX, Blackboard Windows, and
CBord Retail Transaction Interface. At the MFP,
users can authorize themselves as valid campus
card account holders, make copies, release
jobs, and pay for these services in real time,
directly from their campus card account. See the
Managing Devices chapter in the Equitrac Express
Administration Guide.
Offline operation In the event that SOP fails to connect to the
Equitrac DCE service, you can configure SOP to
continue the MFP lock down, allowing users to
authenticate based on account information stored
in local MFP cache. SOP gathers job data in local

260
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

cache, and forwards the accounting details to the

DCE service when it is back online. See Offline
Operation Through DCE Caching for configuration
instructions.
Integration with third party applications SOP tracks job details generated from supported
third party applications. Currently, the third-party
applications supported for scan are SharePoint
and RightFax.
Support for multiple DCE servers You can designate up to 4 different DCE servers
— one primary, and up to three backup servers.
We recommend that the primary DCE is located
on-site to allow for the fastest possible data
transfer. Other DCE servers can be located off-
site.

Installation and Configuration

This section describes how to install Nuance Unified Client for Ricoh Smart Operation Panel on
supported multifunction printers (MFPs) and configure the product for initial start-up. In addition to this
guide, ensure that you have any documentation related to your Equitrac product suite, documentation
for your MFP, and the DRS User Guide.
Note: This guide assumes that you are installing the Equitrac products (servers and embedded
applications) in a Windows network environment. This guide does not provide any information for
third-party software (including databases) or operating system support.
Prerequisites: Before You Install
Please see Checklist: Nuance Unified Client for Ricoh Smart Operation Panel implementation on page
236 for all prerequisites.
Server-Side Configuration
Nuance Unified Client for Ricoh Smart Operation Panel supports multiple Nuance product servers
either individually, or simultaneously. The client can either act as a Ricoh Authentication Agent, or run as
a regular Android application on the SOP. The following is a breakdown of the supported scenarios:

Scenario EO/EE AutoStore Output Manager Authentication

Agent
Equitrac Yes Yes
Standalone (PCC
5)
AutoStore Yes No
Standalone (no
device locking)
Output Manager Yes Yes
(with device
locking)
Output Manager Yes No
(no device locking)
Equitrac + Yes Yes Yes
AutoStore

261
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Scenario EO/EE AutoStore Output Manager Authentication

Agent
Output Manager Yes Yes Yes
+ AutoStore (with
device locking)
Output Manager Yes Yes No
+ AutoStore (no
device locking)

Additional Documentation
You may need to refer to one of the following documents when performing server-side configuration
tasks.

Guide When to refer to this guide Where to find the guide

Equitrac Office /Express Before installing Equitrac Installed automatically with
Planning Guide Office or Express, use this Equitrac in the Program
guide to select the appropriate Files\Equitrac\Express
combination of product variables \Documentation folder.
to support the needs of your
institution or organization.
Equitrac Office Installation Guide Use this guide to perform an Installed automatically with
Equitrac Express Installation initial installation or upgrade. Equitrac in the Program
Guide Files\Equitrac\Express
\Documentation folder.
Equitrac Office Administration After installing Equitrac Office Installed automatically with
Guide Equitrac Express or Express, use this guide to Equitrac in the Program
Administration Guide configure advanced options for Files\Equitrac\Express
use on your campus or in your \Documentation folder.
organization.
Device Registration Service Use this online help guide The DRS help is found by
User Guide (Add an Application to determine installation, clicking on the Help button within
section) uninstallation and upgrade the DRS application.
processes.

Equitrac Card Readers

Equitrac USB card readers are typically automatically detected by the device upon start-up. There is
no MFP or server configuration required for Nuance Unified Client for Ricoh Smart Operation Panel
to recognize card reader hardware. Some server configuration, however, is required to ensure they
function properly for the SOP. Some card readers can be configured to detect multiple card types. If
your card reader supports more than one type of card, we recommend configuring it for only the type of
card used.
Note: Card reads within authentication work flows must be configured on the server in System
Manager. Otherwise, card reads are not recognized. For detailed information about configuring
authentication work flows, see the Equitrac Office or Equitrac Express Administration Guide.

262
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Card reader setup

Equitrac USB card-reader models are typically plugged in to the USB port located on the left side of the
Smart Operation Panel. The cards require no further configuration. The following Equitrac card readers
are supported:

Table 6: Vendor and Product IDs

Card Reader Vendor ID Product ID

Equitrac Generic card reader 13AD 041F

Equitrac Mifare card reader 13AD 9CA5

Equitrac Legic card reader 13AD 9CA6

Equitrac HID card reader 13AD 9CA7

Equitrac Magstripe card reader 13AD 9CA8

Equitrac Contact Based card 13AD 9CA9

reader

Equitrac Hitag card reader 13AD 9CAA

Note: Third-Party card readers which are supported by the Ricoh device may also be used. Such
readers may require their own license. See the respective card reader documentation for more
information.
Disconnect or reconnect the USB Card Reader
Ricoh devices have more than one available USB port. Equitrac card readers can occupy the USB port
located to the left side of the SOP Panel, and can also leverage the internal USB port via an additional
cable.
There are no special hardware considerations when adding or removing an Equitrac card reader. To
remove a card reader, simply unplug it. To add a card reader, plug it in to the above port.
USB Keyboards
Starting with the Ricoh PCC5 release, Ricoh Smart Panel devices no longer support the use of USB
keyboards. The on-screen software keyboard is used instead.

Server Side Configuration

Licensing Nuance Unified Client for Ricoh Smart Operation Panel
Each Nuance Unified Client for Ricoh Smart Operation Panel installation requires a license applied in
the Equitrac System Manager. You must obtain one license per device, or purchase a license pack that
contains enough licenses for all of the devices you want to enable for use. You can buy single licenses
or license packs as needed.
If you intend to use Equitrac to scan to external destinations, a separate Capture and Send license
is also required. Third-party or other native scan applications do not require separate licenses from
Equitrac.
Once you obtain the licenses, you need to activate them in the Equitrac System Manager. By default,
System Manager resides on the machine that hosts the accounting server. However, System Manager
may be installed on any machine on the network that has a connection to the CAS.

263
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. Open System Manager by selecting Start > All Programs > Equitrac Office/Express > System
Manager.
2. In the Select Accounting server dialog, choose the CAS with which Equitrac System Manager is
associated, then click Connect. If the server is not listed, enter the host name or IP address in the
server field.
3. When System Manager opens, click Licensing in the left menu pane.
4. Under Current tasks, click Add license, or click <Add...> in the right pane.
5. When the Equitrac activation window opens, click Next to begin the activation process.
6. Enter the serial number for each components you want to activate. These serial numbers were
supplied with your software. After you enter each complete serial number, click Add to add it to the
list, then enter additional serial numbers as required.

7. When all numbers are entered, click Next.

8. Select Automatic online activation or Manual activation, and click Next.
Note: If you do not have a connection to both the Internet and CAS, choose Manual activation.

9. For Manual activation, do the following:

a) Contact Nuance Customer Support at https://nuanceimaging.custhelp.com/app/imaging/contact/
or by telephone to obtain the corresponding activation codes.
b) After receiving the required activation codes, click Finish to continue.
c) On the Add licensing Information dialog box, enter the Activation code, and click Add.
d) The activated software license appears in System Manager.
10.For Automatic online activation, do the following:
a) In the Embedded device licensing screen, select Ricoh from the Manufacturer list, then click
Next.

264
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

b) Follow the Activation wizard prompts to provide contact information. If you have already
registered one or more Equitrac components, the Activation wizard fills the form with previously-
collected data.
c) The Activation wizard displays a Collecting information... message while retrieving system data.
If you want to omit technical details about your system, click the Show technical details button
and select the information you do not want to transmit. You must transmit the following:
• Accounting server serial number
• Domain-qualified print server name
• Organization name as registered in Windows
• Fully-qualified server DNS name
d) When the Activation wizard is ready to transmit the information, review the collected data. Choose
whether to send optional data with your activation request.
Note: The Activation wizard transmits the data using an HTTP connection to the Equitrac
activation server. If the connection fails, the Activation wizard prompts for verification that
you have configured the default gateway correctly, and that the Internet is accessible from
this machine. You can retry or cancel the activation request at this point. If you cancel, the
Activation wizard prompts you to use manual activation instead
e) Once the Activation wizard sends the activation data and Equitrac returns the activation code, the
Wizard automatically records the license activation in System Manager, and displays a summary
of the activation results:
• Activation code
• Description
• Serial number
• Status (Success; Invalid- the serial number is invalid, or Denied- the serial number was valid
but not accepted)
If the License is Invalid
If the status is Invalid, ensure that you entered all serial numbers and activation codes precisely. Each
component requires a separate license—unless you purchased a suite license. If the problem persists,
contact the Equitrac Customer Support Center to resolve this problem.
If the Serial Number is Denied
If the status is Denied, the serial number may already be registered to a different system ID. Contact the
Equitrac Customer Support Center to resolve this problem. Switch to the Assignment View in System
Manager, to see the number of licenses purchased and the number of licenses used.
Add a Printer on a TCP/IP Printer Port
Nuance Unified Client for Ricoh Smart Operation Panel makes use of standard Windows TCP/IP printer
ports. When setting up your device, note the following:
• Use the standard Add Printer function included in the Windows OS.
• Use only TCP/IP Ports. Do not use Web Services for Devices (WSD) ports as they are not
supported.
• If the device is part of a group of devices available to print from a designated queue (pull group), it
must use a driver compatible with all other devices in the pull group.

Server-Side Configuration
After you complete the install and configuration of Nuance Unified Client for Ricoh Smart Operation
Panel on the MFP, you need to register and configure it on the Equitrac Office or Equitrac Express Core
Accounting Server (CAS). The server-side settings determine how the software operates on the MFP.

265
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configuring Nuance Unified Client for Ricoh Smart Operation Panel Embedded Devices
Each embedded device entry in System Manager must be associated with a physical device (MFP).
Once Nuance Unified Client for Ricoh Smart Operation Panel is installed, your device communicates
with the Device Control Engine (DCE) specified during the installation and configuration via the DRS
component, an embedded device entry is automatically created in the Equitrac Office or Equitrac
Express system, only if you applied the software license before installing the software on the MFP.
There are two methods of registering Nuance Unified Client for Ricoh Smart Operation Panel MFPs as
devices in System Manager:
• Through automatic creation (the default method)
• By manual registration and configuration
Automatically Creating Embedded Devices
Equitrac Office or Equitrac Express automatically creates the Unified Client for Ricoh SOP devices if you
have applied the licenses first, and have already configured the device with the location of the DCE.
When you connect an MFP that hosts Nuance Unified Client for Ricoh Smart Operation Panel to the
network and turn it on, the application automatically looks for the DCE. The DCE can provide a license
confirmation to the device, as well as pass the device information to System Manager. After a successful
connection and licensing approval, the embedded application appears in the System Manager >
Devices listing.

Note: You can rename the auto-created entries as needed using terms and descriptions appropriate
for your organization by right-clicking on an entry and selecting Edit from the menu.

Manually Configuring Embedded Devices

Use the System Manager > Devices link to manually add an embedded device that is associated with
a single physical device. This includes enabling secure document release (SDR) and release behaviors,
as well as copy, scan and fax access on each MFP.
Before installing and registering each MFP as an Equitrac Office/Express device, ensure that you have
activated the appropriate SOP license for the device on the Equitrac Core Accounting Server (CAS).
The following procedure assumes you have already registered the physical device hosting Nuance
Unified Client for Ricoh Smart Operation Panel within System Manager. For details on performing this
procedure, see the Equitrac Office or Equitrac Express Administration Guide.
To register each device with CAS, perform the following procedure on an Equitrac Office/Express
administrative workstation:
1. Open System Manager and select the Devices link. The right pane displays the devices registered
in System Manager.
2. Right-click on the device and select Add embedded device to open the Embedded device dialog.

266
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Enter a Name and Description for the embedded device.

4. Specify the Server hosting the DCE associated with this physical and embedded device.
5. Select Ricoh SmartPanel from the Type drop-down list.
6. Enter the Serial number for the device. This must match the serial number as shown on the MFP
itself.
7. Leave the HID decoding setting at Default. For information about this setting, see the Equitrac
Office/ Express Administration Guide.
8. Click Pricing to configure pricing at the embedded device level. You can create a price list
then assign it as the default price list for all of the device functions, or set a price list for each
separate function. For details on configuring price lists, see the Equitrac Office or Equitrac Express
Administration Guide.
Note: Unless a new price list is designated for the device, the default price list is used.

9. Click the link beside Tracked activities to override default tracking options for a particular embedded
device. See Configuring Workflows.
10.If you have defined Rule sets in System Manager, select one from the drop-down list to apply to this
embedded device. For more information on creating rule sets, see the Equitrac Office or Equitrac
Express Administration Guide.
11.From the Offline access drop-down list, select the type of offline access users have when the device
cannot connect to DCE.
•None: This option denies all normal user access to the device, although system administrators
can still access the System Administration functions.
• Cached only: With this option, only users who have previously logged in can access the device
using their cached login credentials and any cached billing values.
• Allow all: This option permits any user credentials for login and any billing values for access to
device features.
12.Select a Prompt for billing code option from the drop-down list.
Default: This option uses the billing code settings from System Manager > Configuration >
•
User interaction > Session flow. See Enabling the Billing Code Prompt.
• Prompt: This option prompts the user for a billing code even if billing code prompts are not
enabled globally.
• Do not prompt: This option disables the billing code prompts even if they are enabled globally.
13.Specify how SOP will handle Release behavior for documents at the device:
• First is released: Released: only the first document in the user’s queue
• Prompt: Prompts the user to release all or select documents for that user

267
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Release all at login: Releases all queued documents for the current user automatically after
successful login.
Note: Secure printing must be enabled on the print queue. See Enabling Secure Printing.

14.From the Disclaimer drop-down list, select the disclaimer you want to use at the close of an email.
For information about setting up disclaimers, see the Equitrac Office/Express Administration Guide.
15.From the Enable guest user drop-down list, select the option to use for unrestricted access to the
device:
• Default uses the configured global setting.
• Disabled overrides the global setting, and denies access.
• Enabled overrides the global setting, and allows access to guest users.
16.Click OK to save the settings.
Licensing the device
Scan workflows, except those using Scan-to-Me, require an Equitrac Capture and Send license. You
must obtain a license per device to enable these options.
To assign a Capture and Send license, do the following:
1. Open System Manager, and select Licensing in the left pane.
2. Select the Assignment View tab to open the list of all assigned licenses.
3. Expand or right-click the Capture and Send license option, and select Add to open the Assign
license dialog box.

4. On the Assign license dialog box, select the check box for the devices to assign the Capture and
Send license to.

268
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

At the bottom of the dialog box is a counter displaying the number of available licenses and available
devices. These numbers decrease with every license assigned.
5. Click OK after the licenses have been assigned to the desired devices.
The devices assigned for Capture and Send now display under the Capture and Send license
option. To remove an assigned license from a device, right-click the device and select Remove
assignment. The number of used licenses are adjusted accordingly.
Enabling the Guest user
The Guest user in the Unified Client for Ricoh SOP offers the ability to use the embedded solution
for unauthenticated access. Users who are not associated with your enterprise can gain access to
configured features of Unified Client for Ricoh SOP without providing log in credentials, or if mobile
users want to access the system without authenticating. Guest workflows can be configured in the same
way regular workflows are, allowing for many configurable options. Using a Release key is one possible
way the Guest user feature is used; it can also be used to provide access to any workflow configured in
the Guest user workflow container configured on the server, such as Guest access to Native functions.
The system considers the Guest user as a regular user, so Function Access Control rules can be
configured on the server for the Guest user in order to control the exact permissions granted to Guest
users. The server tracks usage in Reports based on the Guest user’s identity.
For example, a workflow can be configured to place a "Guest" button on the device log in screen which
invokes a Follow-You feature. The user can then release documents with a provided key. Depending
upon configuration, such a workflow may behave in the following manner:

Guest user setup

Before setting up a Guest user option, you must configure how you want the function to behave
in Equitrac Office or Equitrac Express. The workflow that you assign to the Guest User function is
configured in the same way as any workflow. Bear in mind what you want the button to do, and create
a workflow to match that functionality. For instructions on creating workflows, see the Equitrac Office or
Equitrac Express Administration Guide.
1. In System Manager, navigate to Configuration > Devices > Embedded devices.
This opens the Embedded devices dialog box.

269
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Ensure the Enable guest user check box is selected. This enables all the Unified Client for Ricoh
SOP-equipped devices to allow Guest User functionality by default. You can then designate which
devices allow Guest User functionality per device, if necessary.
3. Configure the Guest button. You must configure which text appears on the Guest button, as well
as the workflow associated with the button. You must also configure which user account is used for
guest transactions:
a) In System Manager, navigate to Configuration > Security and authentication > Guest user.
The Guest user dialog opens:

b) In the Button title field, enter the text you want to appear on the button to guide users.

270
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

c) In the Workflow container field, enter the container name associated with the button the Guest
user presses to gain access. For information about configuring workflows and containers, see the
Equitrac Office or Equitrac Express Administration Guide.
Note: You can configure the Guest Workflow container to your requirements. The workflow
can contain only Guest-included workflows or standard workflows as well. The container must,
however, use Global scope.
d) Click Verify to ensure the Container provided is valid. A dialog box displays, indicating a pass or
fail.
e) In the Guest user account field, enter the account leveraged when the Guest user function
processes transactions. For information about configuring Users, see the Equitrac Office or
Equitrac Express Administration Guide.
f) Click Verify to ensure the Guest user account provided is valid. A dialog box displays, indicating a
pass or fail.
g) Click OK.
To allow override of the global device settings, thereby allowing or disallowing a device using the Unified
Client for Ricoh SOP the Guest User functionality regardless of the default setting, do the following:
4. In System Manger, navigate to Devices. In the right pane, double click the embedded device you
want to configure. The device’s Embedded device dialog opens:
5. Select the desired Guest user functionality from the Enable guest user drop-down list:
• Default uses the default settings for Guest users as configured above.
• Enabled activates Guest user functionality for this device regardless of the default setting.
• Disabled deactivates Guest user functionality for this device regardless of the default setting.
Configuring Workflows
A variety of scan, print, native scan, and native print and copy workflows can be configured in System
Manager. Workflows can be configured to be accessible to all users, or only available to users assigned
to specific departments.
Common scan workflows can be configured for email, network folders, RightFax and SharePoint
destinations. Workflows are configurable, and can be used to create icons to be added to workflow
containers allowing quick access to the specific functions at the device.
To create a workflow, do the following:
1. In System Manager, navigate to Configuration > Workflows and scanning > Workflow
management.
When the Workflow management dialog box first opens, a list of preconfigured workflows is
displayed. Any of these can be edited to suit the scanning needs of the organization. Additionally,
custom scan-related, system-managed and device-managed workflows can be created.

271
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. In the Workflow management dialog box, click <Add...> (or select an existing workflow from the list)
to open the Workflow definition dialog box.

3. Enter a descriptive Name for the workflow which users can identify and select at the MFP.
Note: If the length of the chosen name exceeds the available space on the display, the name is
truncated to fill the available space.

4. Click the Active check box to enable the workflows to be available to use.
5. From the Scope drop-down list, select either Departmental or Global. Global workflows are
accessible to all users, while Departmental workflows are available to users assigned to a specific
department.
Note: Departmental workflows must be Active in order to apply them at the department level.
Inactive workflows are listed in the Department properties, but cannot be applied.

6. From the Destination drop-down list, select the workflow type.

7. Define the scan destination attributes by clicking the ellipsis button (...) beside the corresponding
attribute’s default value in the Define attribute <Attribute> default value dialog box and click OK.
8. Click the Image preferences button to set the scan workflow resolution and type.
9. Click the Output file size button to define the scan file size settings.

272
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

10.Click the Output formats button to select the scan output formats that will be available to users
at the scanners. These formats are produced out of the device proper, as opposed to those set up
through the SPE. See the Equitrac Administration Guide for more details on SPE settings.
11.Click OK to save the workflow.
12.Click OK again when the all the desired workflows have been configured.
Note: If only one workflow is configured and available in the Launcher (or equivalent) container
upon user login, the Unified Client for Ricoh SOP automatically starts that workflow. If the workflow
is in a 'child' container, autostart does not apply.
For more information, see the Equitrac Office or Equitrac Express Administration Guide.
Tracking Jobs Originating at the Device
To correctly track jobs that printed from the MFP, enable print tracking through the embedded device.
1. Select the embedded device from the Devices list.
2. Click on the link beside Tracked activities to open the Embedded device configuration dialog box.

3. Select either Copy or Scan for the activities you want to track.
4. Click OK again to close the Embedded devices dialog box.
Configuring System Timeout Behavior
Nuance Unified Client for Ricoh Smart Operation Panel has various timeout behaviors which work
separate from native Ricoh timeouts, and control the access to the software when a device is left idle
for long periods of time. Some timeout durations are user configurable. The following table explains the
timeouts and their functions:

Timeout Set In Behavior

Session Activity System Manager > This timeout applies to all
Configuration > Devices > software functions, such as
Embedded Devices login, Scan-To-Me and Follow-
Note: The default value is You Printing. When this timeout
60 seconds, and must be expires, the user is immediately
set to at least 30 seconds logged out.
if overridden.
Note: If any timer is set
to a value less than the
session activity timer, the
time for session activity
is used instead of the set
value.

Session Summary Hard-coded to 60 seconds. If a user fails to log out when

Cannot be modified. finished using the device, logout
occurs after this time.

273
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Warning: Administrators of Ricoh MFPs have the ability to set device-specific Auto-Off and energy
saver timeouts. These timeouts should not be set at less than 300 seconds (5 minutes). If timeouts
for SOP activity have not been reached when the timeouts for the device engage, the device must
be restarted to re-enable Nuance Unified Client for Ricoh Smart Operation Panel. To avoid this issue,
always ensure the device timeouts exceed any SOP-specific timeouts by a wide margin.
Configuring Card Self-Registration
If you want users to self-register their swipe cards, you must enable this option in System Manager.
When a user swipes an unregistered card, they are required to log in to the MFP with valid primary
and secondary user credentials. The information the user must enter depends upon the authentication
mechanisms set in System Manager.
1. Open System Manager and navigate to Configuration > Security and authentication > User
authentication.

2. Select one or more Authentication mechanisms:

• Equitrac Office or Equitrac Express PINs – Leave selected.

274
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• External user ID and password – Select to verify all user information such as Windows or LDAP
information.
• Equitrac PIN with external password – Enable if users swipe their cards for identification, and
must also enter their domain user account password. Equitrac Office or Equitrac Express cross-
checks the database for the corresponding Equitrac account name, then verify the credentials
against the selected external authority for network log on.
3. Select Card swipe only or Card swipe or keypad entry from the Input type drop-down list.
4. Select Always or Only with keyboard login from the Secondary prompt drop-down list. The If
PIN2 available and If PIN2 available or keyboard login options are not supported in Nuance
Unified Client for Ricoh Smart Operation Panel .
Note: If a user has a secondary PIN or external password associated with their user account, they
must enter their secondary user credentials on the MFP front panel when prompted. If the user
does not have a secondary PIN or password associated with their user account, they can leave the
field blank to proceed.
5. Select the Auto-register primary PINs check box. Optionally, you can select Register as alternate
PIN to record the PIN as the alternate PIN instead of the primary PIN. The Auto-register primary
PINs option must be selected for card registration.
6. Click OK to save the changes.
The next time the user swipes the card, their account information is automatically associated with the
card, and they can log in without manually entering their user credentials.
Enabling Secure Printing
Secure printing holds documents in a secure print queue until the user releases the document from
Nuance Unified Client for Ricoh Smart Operation Panel .
Secure Printing on the Physical Device
1. Open System Manager and select Devices from the left pane.
2. Click on the print queue you want to configure. You may have to expand the Physical device and Port
to see the print queue.

3. In the Print queue summary dialog, set the Secure Printing option to Enabled from the Behavior
section, and click OK to save the changes.

275
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Enabling Secure Printing on the Embedded Device

When an Embedded device is created automatically, its SDR functions are disabled by default. In order
to use SDR, these functions must be enabled.
1. Open System Manager and select Devices from the left pane.
2. Click on the embedded device you want to configure.
3. Check the option Enable secure document release, then click OK to save the changes.
Note: The option may be unavailable. You must still click OK to effect server changes and enable
SDR.

Configuring Follow-You Printing

Follow-You Printing extends the basic functionality of secure printing by allowing a user to release
a print job to other compatible devices in the organization. Even if you deployed multiple DRE print
servers—each of which manages a separate set of devices—you can configure Equitrac Office or
Equitrac Express to allow printing across multiple print servers.
For example, a user can submit a print job from their computer, and while on the way to a meeting in a
different section of the office, they can walk up to any MFP (with the embedded application installed on
it) and pull the job to a compatible printer nearest them.
If you want to deploy Nuance Unified Client for Ricoh Smart Operation Panel in a single-server or a
multiserver Follow-You Printing environment, do the following:
1. Enable secure printing on each MFP.
Secure printing sets up a virtual print queue that holds jobs until they are released at the embedded
device by a valid user.
2. Create and manage pull groups.
To allow users to release print jobs through Nuance Unified Client for Ricoh Smart Operation Panel
, you must create Pull groups, then add each physical device hosting the embedded application to a
pull group.
3. Configure the Follow-You print settings.
Determine the site where you want Follow-You Printing to be accessible from, and choose whether
the print job is priced based on its properties before or after it is released.
4. Enable multi-server Follow-You to allow users to direct jobs across multiple servers. (optional)
This option enables users to retrieve Follow-You print jobs on a device connected to a different CAS
and DCE/DRE server.

276
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: See the Advanced Printing Configuration chapter in the Equitrac Office or Equitrac Express
Installation Guide for details on configuring secure printing, Follow-You Printing, and device pull
groups.
Configuring Capture and Send
The Capture and Send feature enables the Unified Client for Ricoh SOP to scan documents to a
network folder on the web via SharePoint, a telephone fax number via RightFax, network folders on your
local area network, and email through your server. You require a Capture and Send license per device
to enable the functions. In the case of SharePoint and RightFax, there must be as many SharePoint
or RightFax destinations as there are SharePoint or RightFax servers (one destination per server).
For example, if each department has a SharePoint server, each one must be added as a valid Scan
Destination. In the case of network folders and email addresses, you can set up scan aliases. For
information on scan aliases, see the Equitrac Office or Equitrac Express Administration Guide.
Note: To use scan features offered through Equitrac Capture and Send, you must install the Scan
Processing Engine (SPE) component of Equitrac Office or Equitrac Express. See the Equitrac Office
or Equitrac Express Administration Guide for information about SPE.

To configure their use:

1. Open System Manager and select Configuration > Workflows and scanning > Scan
destinations. The Scan destinations dialog opens.
2. Click <Add...> to add an application.

3. Once added, configure the scan destination by clicking it. Fill out the fields in the Scan destination
definition dialog if they are not already filled. For detailed instructions on configuring scan
destinations see the Equitrac Office or Equitrac Express Administration Guide.
Note: Not all server settings are applicable to all devices.

Scan-to-Me
Scan-to-Me allows users to scan documents and email the results to a preset email address. The email
address used is pulled from the user’s account information in the Equitrac Account Manager. Note that
users with no email addresses enabled do not see a Scan-to-Me option. If you want to allow users with
a valid email address to use the Scan-to-Me feature in Nuance Unified Client for Ricoh Smart Operation
Panel , ensure that it is enabled in System Manager.

277
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The Scan Processing Engine (SPE) component of Equitrac Office or Equitrac Express is
required.

1. Open System Manager, and navigate to Configuration > Workflows and scanning > Scan-to-Me.
2. In the Scan-to-Me dialog, select the Enable check box. Selecting this option places the Scan-to-Me
button on the Unified Client for Ricoh SOP log in screen, and allows users to access the feature.
Note: You must also ensure the Scan-To-Me feature is in the Launcher Container, and ensure the
Login screen includes a Quick Shortcut using that Container.

3. Under Settings, enable the following options if necessary:

Option Description
Enable advanced settings When enabled, adds a manual configuration
menu to the system, including Scan settings,
Auto density, Feed type, and Filename/type to
the SOP Scan-to-Me screen on the MFP. Users
can click on the menu items to change scan
settings.

278
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Duplexing Sets the default duplex option. Choose either
duplex or simplex.
Scan type Sets the default color option. Choose either
Color scan or Monochrome scan.
Enable To field When enabled, the To field on the SOP Scan-
to-Me screen on the MFP is editable, allowing
users to enter one or more email addresses.
Exclude logged in user email address When enabled, the user can remove their email
address from the To field, and not receive the
scan in their mailbox. If the To field is empty,
then the user’s email address is automatically
put back into the To field.
Enable CC field When enabled, adds the Cc field to the SOP
Scan-to-Me screen on the MFP, allowing users
to enter one or more email addresses. The scan
is sent to users in the Cc list, as well as to the
user who performed the scan.

Note: The Scan-to-Me option is not available to users without an email account associated with
their Equitrac account.

Note: Email functionality is handled exclusively through the server associated with SOP, and not
at the device itself.

4. In the Default group box, set the default Subject and File name attributes for the files resulting from
Scan-to-Me operations:
a) Click the ellipsis (. . .) of the attribute you want to change. The Define attribute box displays.
b) Alter the existing default setting for the attribute by selecting a new one from the drop-down list, or
clicking on the text and replacing it.
Configure the Mail Server
To configure the mail server:
1. Open System Manager and navigate to Configuration > Network environment > SMTP mail
server, then select Add....

279
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Enter your SMTP Email server which is either the server’s DNS name or IP Address.
3. Select Enable TLS and enter a Mail from address for system generated messages. This address
appears in the From field when a user receives a notification email message.
4. Select Basic Authentication if your SMTP mail server requires a user name and password each
time a message is generated.
5. Click OK to save the changes.
Note: General scan through SMTP information is centralized on the server.

Enforcing Color Quotas

Nuance Unified Client for Ricoh Smart Operation Panel can enforce limits on the number of color
copies that any user can make, based on their user account quota limits. If configured to do so,
the software can disable the MFP when a user exceeds their color copy limit. For a more detailed
discussion about Color Quotas, see the Equitrac Office or Equitrac Express Administration Guide.
To enable the software to enforce color copy quota limits, do the following:
1. Open System Manager and navigate to Configuration > Accounting and quotas > Color quota.
2. In the Color quota dialog, select Enable color quota.

3. Select Disable copying on color devices once quota exceeded. This disallows black and white
copying, and stops color copies if users exceed their color quota limits.

280
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Enter a Custom message to display to the user when they have exceeded their color quota.
5. Click OK to save any changes.
Enabling the Billing Code Prompt
If billing codes are enabled on the Equitrac Server, you can determine when the billing code prompt
appears to the user on the MFP. There are two options—after user identification, and at job release.
1. Open System Manager, and navigate to Configuration > User interaction > Session flow.

2. Select one or both billing code prompts.

a) Prompt for billing code after user identification (at copiers) - Typically used in workflows
where only copy and scan are used. The billing code screen appears right after the user logs in,
and before they can access any copier function (including copy, fax, scan, and job release).
b) Prompt for billing code at job release (at copiers) - Used to set billing code behavior on legacy
devices, this causes the billing code screen to appear after the user logs in, and again when they
release one or more print jobs on the Follow-You screen. In the Unified Client for Ricoh SOP, this
setting is ignored. To set up similar prompting for billing code at job release in the Unified Client
for Ricoh SOP, do so within the Workflow. See Configuring Workflows in the Equitrac Office or
Equitrac Express Administration Guide.
3. Click OK to save any changes.
You can override these server-side billing code prompts on a per device basis. Go to System Manager
> Devicesand select the embedded device to open its properties dialog box. Select either Default,
Prompt or Do not prompt from the Prompt for billing code drop-down list.
Operation Through DCE Caching
If Nuance Unified Client for Ricoh Smart Operation Panel cannot communicate with the DCE, the client
goes into "offline" mode. At this point, the device can still authenticate user credentials against its own
internal cache, if enabled. If a connection between DCE and CAS fails, then the device will authenticate
using the DCE server rather than the internal cache. In either case, users whose credentials match a
previously cached set are granted device access; if the credentials do not match, the users are denied

281
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

access. In offline mode, the Unified Client for Ricoh SOP allows the caching of card swipe data through
DCE.
To enable Login caching in the even DCE loses contact with CAS, do the following:
1. Open System Manager and navigate to Configuration > Security and authentication > User
authentication. The User Authentication configuration dialog opens.

2. In the CAS offline behavior section, select the Login caching from the DCE servers drop-down
list.
• Disabled: DCE follows offline behavior settings; the regular rules for cached only and allow all
apply.
• Enabled: DCE authenticates users against its internal cache, rather than contacting CAS.
DCE login caching determines whether a user login is accepted or denied when CAS is offline. If
DCE caching is disabled when CAS is offline, then users cannot login. If DCE caching is enabled
when CAS is offline, then DCE allows users to login only if they had previously logged in when
CAS was online.
For example, if DCE caching is enabled, and User1 authenticated while CAS was online, but
User2 did not, then if CAS goes offline, User1 can still login, but User2 cannot login until CAS
comes online again. Once CAS is back online, then User2 can login, and continue to login even if
CAS goes offline again.
Note: Account limits are not enforced, and Billing Codes are not validated when DCE is
operating without a connection to CAS.

3. Select how DRE servers handle print jobs when CAS is offline.
• Auto select: If account limits are enforced, then the Do not print option is used. If account limits
are not enforced, then the Print, charge accounts later option is used.
• Do not print: Users cannot print, and must wait until CAS is back online in order to print.
• Print, charge accounts later: Users can print, and then the print job is charged to their account
when CAS is back online.
Configuring Account and Session Display
Nuance Unified Client for Ricoh Smart Operation Panel can display account information during a user
session, and provide a Session summary at the end of a user session.
To select the display options you want to have available, do the following:
1. Open System Manager, and navigate to Configuration > User interaction > Session flow.

282
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. In the Optional display fields section, select which fields you want displayed during a user session.
The following options are available:
Option Sub-option
Account name • Display throughout session
• Do not display

Account balance • At start of session (does not apply to this

version of the Unified Client for Ricoh SOP).
• At end of session
• At start and end of session
• Do not display

Session cost • At end of session

• Do not display

CAUTION: The session costs and user account balances displayed at end of a session are
estimates based on average copy costs. The actual values stored on the server may differ from
these values.
Note: In order for the Unified Client for Ricoh SOP Session Summary screen to appear on the
MFP, Account balance and/or Session cost must be set to display at the end of a user session.

Configuring Available MFP Functions

The functions that are available, how they are displayed, and to which users these functions are
presented, is dependent upon various configuration options. When determining which workflows are
available to the user, consider:
• The licensing applied to the device. Scan workflows, except those using Scan-to-Me, require an
Equitrac Capture and Send license. You must obtain a license per device to enable these options.
• Workflow and Workflow Container Settings for the device. For functions to appear, they must be
correctly set in System Manger using Workflows and Workflow Containers. They can then be ordered
and enabled as required by the administrator. The Launcher and Quick Shortcuts bar containers
govern which items appear on the Launcher screen and Quick Shortcuts bar list. These containers
cannot be removed. Other containers, such as the Scan container are supplied for your convenience,
and can be removed or added as needed. Although containers may have workflow associations,
actual workflows are only available if the related features are configured, licensed and available to
the user based on global and departmental settings (see below). For detailed instructions on how to
use Workflows and Workflow Containers, see the Equitrac Office or Equitrac Express Administration
Guide.
• Global or departmental settings. Within Workflows or Workflow containers, you can set functions
to be accessible by any logged in user (a global setting), or by the logged in user’s specific
department (a department setting, which acts as a subset of valid users to allow more granular
control over which functions a user is able to access).

283
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

PCC Workflow and Workflow Container Settings for the device

For functions to appear, they must be correctly set in System Manger using Workflows and Workflow
Containers. Note the following information about Workflow container settings:
• The Unified Client for Ricoh SOP requires a default item for the Quick Shortcuts bar. If there is no
default configured on the server, the Unified Client for Ricoh SOP selects the first item in the list as
the default item.
• If Follow-You Printing or Secure Document Release (SDR) are not enabled in the Physical Device
settings, configured workflows do not appear. Ensure that you have selected and enabled these
options. See Enabling Secure Printing . In some cases after having made a change you need to
force a cache update to the DCE for the change to take effect. See Managing DRC in the Equitrac
Office or Equitrac Express Administration Guide for instructions.
• Devices must have an associated ECSP license and a configured SPE associated for scan
workflows to appear.
• Any item placed in the Quick shortcuts bar, must also be in the launcher.
• If a workflow container has only one workflow, the Unified Client for Ricoh SOP will execute that
workflow, and no further selection is necessary.
• Workflow configurations for Follow-You Printing and Release All contain an option to configure billing
code at release. This setting overrides all other prompt for release configurations in the system.
For detailed instructions on how to use Workflows and Workflow Containers, see the Equitrac Office or
Equitrac Express Administration Guide.

Elements of Nuance Unified Client for Ricoh Smart Operation Panel User Interface
You can perform various functions at any time in the user workflow, depending upon settings. The
Nuance Unified Client for Ricoh Smart Operation Panel user interface is touch-based. Use your finger
or a pointing device such as a stylus to make common touchscreen type gestures, type on the soft
keyboard, scroll lists of options, and perform certain system commands. Users can swipe the screen to
reveal more options, as indicated by the carousel dots. The screen requires that minimal pressure be
applied when navigating the system. The user interface for the Unified Client for Ricoh SOPis presented
in three areas:

284
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 41: Typical Nuance Launcher Screen, indicating the three areas

Figure 42: Alternate screen, showing Nuance Navigation Button

• Title Bar. This area is controlled by the Device, and is used primarily to access the system The
following options are possible:
• Login button. Presents the login screen to authenticate and gain access to the Unified Client for
Ricoh SOP.
• Logout button. Logs the currently logged in user out.
• Moon. Engages system sleep mode. This is disabled when a user is logged in.

285
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• The currently logged in user's name.

• The System Home button, which returns the user to the Ricoh Smart Operation Panel Home
Screen.
• Main Window. This area is controlled by the Unified Client for Ricoh SOP, and is the main interface.
Most user selection and workflow activity is handled through interaction with this area of the UI.
Depending upon the currently active screen, the following options are possible:
• Information Bar. Indicates the current workflow or screen, as well as additional information
such as the current account balance. Also indicates when a list of recent system notifications is
available. Press the Exclamation Triangle (when present) to display these.
• Nuance Navigation Button. When present, displays a list of options relevant to the current
workflow.
• All available workflows. These are determined by the administrator at time of setup, and by the
privileges of the user currently logged in. Workflows that act as gateways to additional workflow
groups are enclosed in square braces. for example, [Scan] opens a menu with additional options.
• OS Bar. This area is controlled by the underlying operating system, and is used primarily for
navigation. Depending upon the currently active screen, the following options are possible:
• Check Status. Offers information about the MFP at the system level. Consult the Manufacturer-
provided documentation for information.
• Back Arrow. Returns the user either to the previous screen, the Nuance Launcher, or the Ricoh
Smart Operation Panel Home screen, depending upon the system screen displayed.
• Down Arrow. When the soft keyboard is displayed on the screen, this arrow dismisses it.
• Home button. Returns the user to the Nuance Launcher.
• SD Card indicator. Indicates the presence of an SD card in use with Secure Operation Panel.

Typical User Workflows

This section describes how to login to Nuance Unified Client for Ricoh Smart Operation Panel and use
its screens and features on the MFP. This section also provides information about entering billing codes
and using campus cards.
If your administrator has enabled account limit enforcement, and/or color quotas, and/or billing codes,
read the following paragraphs before you use Nuance Unified Client for Ricoh Smart Operation Panel .
Account limits – Account limits ensure that you have sufficient funds in your account to pay for print
jobs before the jobs are released from the queue. As you release print jobs in using Equitrac, the
software continuously checks your output against your estimated account balance. If the total cost of
printing selected documents is more than your estimated available fund balance, the server will not
release the print jobs. Instead, if escrow is enabled in the server settings, an error message appears
indicating that the balance is not enough to pay for the printing or copying. After you add funds to your
account, you can login again to release your jobs. In the case of copy jobs, the embedded application
stops the copy job at the point when the estimated account balance is exceeded, and locks access to
the MFP functions. This is available only as a licensable feature in Equitrac Office or Equitrac Express.
Note: Advanced MFPs have a 'multipage copy pipeline'. The MFP may eject a few pages beyond the
account limit on high-speed machines.

Billing Codes – A billing code is a unique combination of characters that represent a charge-back
group. You can assign your transactions to a particular code, and Equitrac Office or Equitrac Express
tracks the characteristics of copy or print jobs assigned to the code.
Color quota – Color quotas are used to limit the amount of color copying and printing that you can
produce. As you copy or print, Nuance Unified Client for Ricoh Smart Operation Panel compares your
output to your color quota balance (in number of pages). Once you reach the quota, the application
disables the color function on the MFP. If you still have funds remaining in your account, you can

286
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

switch settings to black and white and continue to produce black & white copies or print black & white
documents only. You are able to produce color output only when your color quota is reset on the server.
Logging Into Nuance Unified Client for Ricoh Smart Operation Panel
To login to Nuance Unified Client for Ricoh Smart Operation Panel , users must login from the SOP's
login screen. This means the SOP must be running before logins are permitted. If the MFP displays the
Ricoh Smart Operation Panel Home screen, users must first press the Login button on the top menu bar
to start the Unified Client for Ricoh SOP.

After the Unified Client for Ricoh SOP starts, you can display the Login screen either by tapping
anywhere in the main window, or swiping across the screen in either direction:
Note: Nuance Unified Client for Ricoh Smart Operation Panel acts as a device Authentication Agent,
allowing it to lock and unlock the device and collect transactions.

287
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

On this screen, users must provide valid authentication credentials before they can access the device
functions available to them.
If there are quick shortcut options available through a configured container, they display directly on
both the Welcome and Login screens, as above. Users can opt to select the desired option and then
authenticate, so when they login, they are taken directly to the workflow they selected. Otherwise,
users are presented with the default option the administrator has chosen in the Quick Select Container,
which contains their selection of workflows, governed by how Workflows and their respective Workflow
Containers are configured in Equitrac Office or Equitrac Express, after they login.
The login process follows this general path:
1. If not active, start the Unified Client for Ricoh SOP by pressing the Login button on the top menu bar.
2. Touch anywhere in the main display window, or use touchscreen type gestures to swipe in either
direction on the screen to display the Login screen.
3. (Optional) Select the desired Quick Selection option from the list on the screen, if available.
4. Enter valid login credentials using the on-screen keyboard (invoked by tapping within the User ID
field), or by presenting your card.
Depending on configuration, one or more login fields may appear. The following are examples of
valid login credentials:
• Equitrac primary PIN only
• Equitrac primary and secondary PINs
• Windows Networking credentials — network user name and password
• Present a card at the card reader
• Present a card and Equitrac secondary PIN
• Present a card and provide Windows password
• Equitrac primary PIN and Windows password
• Campus card swiped at the card reader. (for Equitrac Express only)

288
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The last prompt field on the Login screen is masked to protect your login credentials. If
secondary prompts are not enabled on the server, the User ID field is masked (***). If secondary
prompts are enabled, the second field is masked instead.
5. Touch the blue Nuance Login button. The Launcher screen or selected Quick Selection workflow
opens.
If you have difficulty logging in
If your credentials are not validated, an error message appears requiring you to try your login again.
If the system does not recognize the swipe card you used to authenticate, you are prompted to enter
your authentication details if the card auto-registration feature is enabled. The next time you swipe the
card, your login information is populated automatically. Otherwise, the system displays a "login failed"
error.
Entering Billing Codes
If billing codes are configured, the Accounting/Billing Code screen opens before a user accomplishes
a task. The code entered here applies to copy and scan jobs. If overrides for Follow-You printing are
enabled, a billing code which overrides the first can be entered and upon job release in the Follow-You
Printing screen.
Note: If an account is configured with only one available billing code to charge against, and billing
codes are required, then that code is automatically selected and the Billing Code screen does not
appear unless the "Billable" option is enabled.

1. In the Billing Code field enter the billing code, if required.

If you don’t know the code, select the Search button, represented by a magnifying glass icon. An
onscreen keyboard displays, allowing you to enter search criteria. The keyboard can be dismissed to
select from the resulting list of billing codes if it covers some of the results. The list initially contains
all billing codes, and then narrows to a subset based on the search criteria entered. The list contains
the first 100 codes that matched your search. Use swipe gestures to browse through billing codes
and select the correct code, which then populates the Billing Code field.
2. If configured, select whether the job is Billable or not by tapping the check box.

289
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

This option determines if the transaction is billed to a user, group, or department, or if it is only
entered into the system for reporting purposes.
3. Select Done to continue.
If the Billing Code validation is enabled, the billing code is validated when you select Done. If you
searched for a code and selected it from the list, it is validated immediately. Billing code validation is
set in System Manager > Configuration > Session Flow > Validate Billing Codes.
Note: If the billing code you entered is invalid, try performing a search and selecting the code from
a list instead.

Using Follow-You Printing

The Follow-You Printing screen displays all the queued documents associated with your login
credentials, or release key. By default, the list displays documents in order from longest-queued to most-
recently queued.
Each time you release a document from the Job list, the Unified Client for Ricoh SOP checks your
estimated available account balance. If account limits are enforced, and the total cost of the selected
documents exceed the available account balance, an error message displays indicating that the account
balance would be exceeded and the items will not be printed. The current pages, documents, costs
associated and other information appears in real time for the print jobs selected in the document details
window at the lower right of the screen.
Note: Account limits are a licensable feature available in Equitrac Office or Equitrac Express.

Available operations on the Follow-You Printing screen are:

• Select - or + to adjust the number of copies.
•
Select the icon to force color jobs to print in black & white.
• The top line of the documents list indicates the number of documents available. To select or deselect
all documents, press the selection circle next to Print Jobs.
• Select or deselect individual print jobs by pressing the print job's respective selection circle.
• Delete individual print jobs by swiping to the left on any print job's row to reveal a trash can icon.
Then, press the icon.
• Select Print to release all selected documents.
The following options are available by selecting the Nuance Information Menu icon at the top right of the
screen:

290
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Select Select All to select all documents. To deselect a document and not release it for printing,
press the respective print job's selection circle.
• Select Print & Save to release any selected print job(s) and save them in the print queue.
• Select Delete to remove all selected documents from the Job List without printing them.
• Select Refresh to update the document list.
The following options are available from the Title and OS Bars:
• Select the Home button to return to the Device Launcher screen.
• Select the Back Arrow to return to the Nuance Launcher screen.
• Select Logout to end your current session.
Scanning
Nuance Unified Client for Ricoh Smart Operation Panel offers the ability to perform many different scan
tasks, including scanning to email and network folders through SharePoint (team site) and scanning
directly a fax through RightFax. To use these options, the Capture and Send function, which enables
the Unified Client for Ricoh SOP to perform these tasks, must be set up and licensed. See Manually
Configuring Embedded Devices for information about enabling these features.
Nuance Unified Client for Ricoh Smart Operation Panel acts as a user-facing experience to handle
numerous scanning solutions. For example, Equitrac Scan-to-Me functions are handled through the
Unified Client for Ricoh SOP, and users can scan to network folders, email addresses or directly to fax
recipients based on the workflow chosen. The workflow experience for each feature is identical to an
end user regardless of the product used to process the scan. The options available to a user depend
upon the administrator's setup, the user's settings, and which features are licensed. Scan settings and
processes are handled through the Ricoh Scan GUI service.
Detailed information on setting up scan workflows is found in the Equitrac Office or Equitrac Express
Administration Guide.
Scanning can proceed either by using the Automatic Document Feeder (ADF) on the device, or by
scanning directly from the glass of the MFP one sheet at a time. The actual scanning process and scan
settings per job are handled through the Ricoh Scan GUI Service.
Note: If a user wants to quit a scan, this can be done using the Stop button at any time. However, if
the document being scanned is using the ADF, the pages will finish running through the ADF before
stopping the process.
Note: Users can append pages to documents mid-scan job when scanning from the glass. However,
appending pages to scan jobs through the ADF is not supported.

Terminology
For the purposes of this section, the terms used refer to the following:
Scan Task: An operation which delivers a scan to a particular end point. This can me a destination such
as an email address or network location, or a service such as a RightFax operation.
Documents: One or more pages that will be scanned. There can be as many pages per document as
required, within the limits of what the device allows.
Scan Job: A collection of Documents. You can scan multiple Documents at a time, which are then
concatenated into a Scan Job.
Job Details: A collection of metadata that is applied to a Scan Job. Typically, any collection of
Documents will share the same Job Details through their inclusion in a Scan Job.

291
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Prepare to scan
Log in to the Unified Client for Ricoh SOP at the device with your credentials. Place the document you
want to scan into the Automatic Document Feeder (ADF) or, onto the glass of the scanner.
Note: You can place your document at the start of the workflow, or at any time prior to scanning.

Select a Scan workflow from the available options. Scan workflows are typically set up in System
Manager to simplify and automate the Scan process. The following is an example Scan-To-Me screen.

Note: If Capture and Send is not licensed and configured, then only Scan-To-Me functions are
available.

Note: The Scan Processing Engine (SPE) component of Equitrac Office or Equitrac Office or
Equitrac Express must be installed to enable any scan functionality.

Depending upon the destination of your scan, you may be asked to provide specific meta data. These
Job Details are associated with the Scan Job in question. This information determines specific attributes
used in the routing and type of scan produced. Depending upon how each Scan workflow is configured
on the server, some Job Details are collected automatically based upon your login information.
Information that is collected automatically may be changeable. For example, your email address may be
filled in automatically when sending a scan as a mail destination in the From attribute. However, if the
configuration allows it, you can change this to a different address. In some cases, these attributes are
configured to be static, in which case you cannot override them, and they may not appear altogether.
For this reason, the changeable fields presented to you at the device may differ from Scan Task to Scan
Task, and even from user to user, depending upon configuration. A list of metadata by workflow type
includes:
• Scan-To-Me or Scan to Email
• To: The email address to route the completed scan. For this workflow, the To field typically auto-
populated with the email address associated to the logged-in user.
• Cc: The email address of any other recipient to whom the user wants to send the scan.
• Subject: The subject of the email when delivered. Typically, this defaults to Scan-To-Me.
• Body: Any text the user wants to include in the body of the email message containing the
resulting scan.
• File Name: The desired name of the scanned file. This typically auto-populates with system
information.
• Scan To Network Folder
• Network Folder: The fully qualified UNC path to the network scan folder. The resulting scan is
deposited into this location on the network.

292
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• File Name: The desired name of the scanned file. This typically auto-populates with system
information.
• Delivery Format: The desired format for the finished scan. Typically, scans are delivered in PDF
format, but this selection field allows a user to select whatever formats are offered through the
device setup. Press the field and select the desired option. Note that this list can often be scrolled
to display more options than those which fit on screen. See Delivery formats on page 293 for
more information.
Note: If a field is static, you will not be able to change the information. These fields appear for your
information only.

Note: If a field has an asterisk (*) next to it, the field is required, and you must provide valid
information for the field if not prepopulated.

Note: One you have entered metadata and started the scan workflow, you must restart a new
workflow to enter different metadata. If you want to reuse the existing data, you can simply start a new
scan job and the fields prepopulate with the last-used metadata.
Important: If you want to change the Scan settings, such as paper size, dpi, or brightness, press
the Change button. This opens a new dialog box. The options for Scan Settings are governed by
the abilities of the MFP hosting the solution. Depending upon licensing and your configuration, full
scan integration with AutoStore is supported. Make the changes you want, then save and you will be
returned to the scan workflow.
Delivery formats
Depending upon the scan task, the Unified Client for Ricoh SOP can deliver it in various different file
formats. The supported file formats depend upon the server scan workflow settings, the delivery formats
supported by the device, and the settings configured by the Administrator. See the Equitrac Office or
Equitrac Express Administration Guide for details. Available file formats are:

Format Description OCR

PDF (Image) Basic PDF - Not searchable.

MFP’s Output The PDF created by the device

itself. All other formats are
created through the SPE.

Searchable PDF Basic Searchable PDF.

TIFFs A single TIFF image per page

scanned.

Multi-Page TIFF A single TIFF file that contains

multiple pages in the file.

JPEGs A single JPEG image for each

page scanned.

PNGs A single PNG graphics file for

each page scanned.

Searchable PDF MRC Searchable PDF with additional ✓

compression. Useful for black
and white documents with a
large amount of text.

293
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Format Description OCR

Searchable PDF/A Searchable PDF meeting PDF/ ✓
A-1b Archiving Standards.

RTF Rich Text Format, a specification ✓

originally published by Microsoft
for cross-platform document
interchange among software
applications.

Word (.doc) - True Page Native Word - 2000 to 2003 - ✓

Matches most closely with the
scanned text, but is more difficult
to edit.

Word (.doc) - Flowing Page Word 2000 to 2003 - Uses Word ✓

formatting to simplify editing, but
does not match as closely to the
original.

Word (.docx) - True Page Word 2007 and 2010 - Matches ✓

most closely with the scanned
text, but is more difficult to edit.

Word (.docx) - Flowing Page Word 2007 and 2010 - Uses ✓

Word formatting to simplify
editing, but does not match as
closely to the original.

Excel (.xls) Excel 2000 to 2003. ✓

Excel (.xlsx) Excel 2007 to 2010. ✓

Searchable XPS Searchable XPS (Microsoft’s ✓

Portable Document Format).

Text Unicode text with no line breaks ✓

(line breaks added at the end of
paragraphs, but not on the actual
line of text).

PDF/A (image) PDF meeting PDF/A-1b

Archiving Standards.

Using LDAP Email Search

LDAP email look-up can be used from the Scan-To-Me screen or any scan to email-enabled feature. In
order to use LDAP search, it must be enabled and configured on the server. See the Equitrac Office or
Equitrac Express Administration Guide for details. If not configured, the search magnifying glass icon
does not appear. To perform a search, use the search magnifying glass icons located beside any To and
Cc fields in workflows that use them.
To perform an email search, do the following:

294
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. Select the Magnifying glass button beside the To or Cc fields to search for and add addresses to
the corresponding field.
Note: If there are no search criteria entered, the list below the search box contains the entire
LDAP email directory.

After you complete this step, a Search screen opens:

2. If not already displayed, press the search magnifying glass icon to display the keyboard.
3. Enter your search criteria. The list below reflects email addresses that match the criteria as you type.
4. When you finish entering your search criteria, or the list displays the correct result, dismiss the
keyboard using the down arrow, and then press the appropriate email in the list.
5. Select one or more addresses, and click OK to exit the Email Search feature.
6. Make a selection from the results, and touch OK. The information populates the To or Cc field.

Reference
This section describes options for the Nuance Unified Client for Ricoh Smart Operation Panel objects
and documents return and status codes.

Application properties
A Device Registration Service application profile for the Nuance Unified Client for Ricoh Smart
Operation Panel specifies connection information for an AutoStore server and a Print Manager server.
This information allows an MFP or MFD to use capture and print management services on these
servers.
These properties appear in the Device Registration Service Details pane when you add or edit a
Nuance Unified Client for Ricoh Smart Operation Panel application. You cannot change the application
type for an existing application.

Property Description

Name A name that uniquely identifies an application.

295
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Application Type To create a new Nuance Unified Client for Ricoh
Smart Operation Panel application in DRS,
choose Ricoh SOP for this option.
The remaining properties shown here appear after
you make this selection. You cannot change the
application type after you save a new application
profile.

AutoStore Server Address Identifies an AutoStore server to be used to

capture documents.
This can be an IP address, a system name (if
the systems are in the same domain), or a fully
qualified domain name. We recommend that you
use an IP address only if it is static.

AutoStore Server Port The port that the AutoStore server uses to
communicate with clients.
This setting must match the port number that is
set on the Preferences tab of the Ricoh SOP
component settings in AutoStore. The default is
3350.

AutoStore Server Use SSL Specifies whether devices should connect to

the server using SSL. This should correspond to
whether Use SSL check box is selected in the
Ricoh SOP capture component Preferences
settings in the AutoStore workflow that will be
used with the devices.

Print Manager Specifies the print manager type.

• None
• Equitrac
• Output Manager

Print Manager Server Address Identifies an Equitrac or Output Manager server to

be used to print documents. The server type must
correspond to the Print Manager setting.
This can be an IP address, a system name (if
the systems are in the same domain), or a fully
qualified domain name. We recommend that you
use an IP address only if it is static.

296
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Print Manager Port The port used by Output Manager to communicate
with device clients. The default port number is
8068 when SSL is not configured on the Output
Manager server. If SSL is configured, change this
setting to 8069.
This option is only available when Output Manager
is selected for Print Manager. SSL is always on
for Equitrac, and the default port setting of 2939 is
not configurable in Device Registration Service.

Print Manager Use SSL Specifies whether to communicate with Output

Manager using SSL.
This option is only available when Output Manager
is selected for Print Manager.

Authentication Specifies whether authentication is to be

performed by the Output Manager server.
This option is only available when Output Manager
is selected for Print Manager.

DCE Server Address The address for the primary device control engine
for Equitrac.
This option is only available when Equitrac is
selected for Print Manager.

DCE Server #2 Address The address of a second fail safe device control
engine for Equitrac. This setting is optional.
This option is only available when Equitrac is
selected for Print Manager.

DCE Server #3 Address The IP address of a third fail safe device control
engine for Equitrac. This setting is optional.
This option is only available when Equitrac is
selected for Print Manager.

DCE Server #4 Address The IP address of a fourth fail safe device control
engine for Equitrac. This setting is optional.
This option is only available when Equitrac is
selected for Print Manager.

297
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for Ricoh Smart Operation Panel device properties
Nuance Unified Client for Ricoh Smart Operation Panel device properties are configured in the Device
Registration Service web console. When configured for a device group, they can be propagated to any
device in the group.

These parameters define the device settings. Click the edit button to edit the parameters for a
device. Click the save button to save changes to the parameters or click the cancel button to
discard changes.

Option Description

Name The name of the Ricoh device or device group.

Address The IP address of a Ricoh device.

Note: This is a device only parameter
and will not be displayed when configuring
parameters for a device group.

Inherit Properties from Group This option is visible only when a device is in
located in a group folder in the Devices pane.
• True specifies to use property settings for the
group. The remaining property settings will be
inherited from the group and unavailable for
configuration here.
• False specifies to configure property settings
separately for this device. The remaining
settings will be available for configuration here
except in their description.

Username The administrator user name for the Ricoh device.

The default is "admin".
Note: Username is not required to perform
a selected action on the device.

Password The administrator password for the Ricoh device.

This field is empty by default.

Application A DRS application with Ricoh SOP as its

Application Type. When a device is in a group,
this property setting is always inherited the group
and does not appear for a device.

298
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Device Group Click a group name in this box to change group
membership. When a device is a member
of a group in can optionally inherit device
settings defined for the group. This allows you
to simultaneously manage settings for multiple
devices. Select the [Devices] option in this list to
remove a device from group membership and
move it to the root folder in the Devices pane.
This option is not visible while you are configuring
options for a new device.

Remote Install Password The remote password for the Ricoh device. This
password is required for uploading the Nuance
Unified Client for Ricoh Smart Operation Panel
installation package to a Ricoh SOP device. The
default remote install password is "ricoh".

MFP SSL (http/https) Specifies whether the device is configured to use

SSL to communicate with the server.
• True when the device is configured to use SSL
(HTTPS).
• False when the device is configured to not use
SSL (HTTP).
Note: If Equitrac or Output Manager is
configured, then set this option to True.

Enable Debug Log Use this to enable debug logging for a device. The
device must be rebooted after you change this
setting.

Server Connections Timeout The period of inactivity (in seconds) at the device
panel before the Nuance Unified Client for Ricoh
Smart Operation Panel automatically logs a user
off the device.
The default is 60 seconds.

Device Type Set this option to match the Smart Operation

Panel type to be supported by this device
configuration:
• C306/406 for C306/406 devices
• Other for every other Ricoh device

299
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Card Reader PID Product ID for the card reader used on the
device. This option is only available when Output
Manager is selected for the Print Manager in the
application settings and Authentication is set to
True.

Card Reader VID Vendor ID for the card reader used on the
device. This option is only available when Output
Manager is selected for the Print Manager in the
application settings and Authentication is set to
True.

Application Package Select an application package from this list. The

selected application package is downloaded
to a device by the Install action. List items are
populated by the uploaded files specified on the
Files tab. Unified Client installation packages are
downloaded from the Equitrac Partner Portal or
from the Web Licensing Portal. See How to upload
a Unified Client installation package to DRS on
page 20 for information about how to add a Unified
Client installation package to DRS.

Assign as home key application Specifies whether the Nuance Unified Client for
Ricoh Smart Operation Panel is invoked by the
Home key on the device.
• True assigns the client as a home key
application on the device.
• False does not assign the client as a home key
application on the device.
This setting is available for with or without
Authentication for the different servers, as
displayed in the table Availability of the "Home
Key" and "Scan Preview" options on page 301.
Important: Assigning a Home key is not
recommended unless the Nuance client is
the authentication application. For example,
the Home key is not supported for common
access card (CAC) single sign-on.

300
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Scan preview Specifies whether the Scan preview option is
available on the device.
• True makes the Scan preview option available
on the device.
• False does not make the Scan preview option
available on the device.
This setting is not available for a print manager
only environment using Output Manager, as
displayed in the table Availability of the "Home
Key" and "Scan Preview" options on page 301.

Baseline installation This field is only visible with the following wirings:
• AutoStore — Auth OFF
• Ouput Manager — Auth OFF
• AutoStore-Output Manager — Auth OFF
By default, this field is set to false and no changes
are made on the device for SP modes and other
settings. If you are using third-party authentication,
set this field to false.

Availability of the "Home Key" and "Scan Preview" options

Availability of this the Assign as home key application and Scan preview options is determined as
follows:

Servers and Home Key Scan Preview Baseline Installation

authentication

Equitrac — Auth ON Available Available Not Available

AutoStore — Auth OFF Not Available Available Available

Output Manager — Auth Available Not Available Available

OFF

Output Manager — Auth Available Not Available Not Available

ON

AutoStore–Output Available Available Available

Manager — Auth OFF

AutoStore–Output Available Available Not Available

Manager — Auth ON

Equitrac–AutoStore — Available Available Not Available

Auth ON

301
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Ricoh SOP Device Registration Device Status

When a device is selected on the Device tab on the Device Registration Service client web page, the
Status bar in the Details pane displays the current device status for the Unified Client application
and scan GUI service. Click the refresh button on the Status bar to display the current status for a
device. The message shows Device not reachable if the IP address is not valid or the device is
currently not visible on the network.

Unified Client Application Scan GUI Service Status Status Message

Status

Installed Installed Installed; Version:

Client: version - Scan
GUI Service: version

Installed Not installed Installed; Version:

Client: version -
Scan GUI Service: Not
installed

Installed Error Installed; Version:

Client: version - Scan
GUI Service: Error
message

Not Installed Not Installed Not Installed

Not Installed Installed Not Installed

Error Error message

Files tab
The Files tab in the Device Registration Service web client lists available Unified Client installation
packages for devices. A package in this list may be specified in the DRS Device profile for a Unified
Client.
Download the installation package in ZIP format from the Equitrac Partner Portal or from the Web
Licensing Portal. The files listed in the following table can be expanded from the ZIP file. Upload all of
these files to Device Registration Service to create the groups shown in the table.

Group Contents Description

Ungrouped ScanExample.zip Files that are not specified in
XML group file.
RicohSOP_XXXX.zip RicohSOP.xml Package metadata file for
version number XXXX (such as
RicohSOP_4308.zip).
SmartScanEx_105.zip Simple scan (GUI services)
example v1.02 for other
(including A3) devices

302
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Group Contents Description

SimpleScanEx_100_00.zip Smart scan (GUI services)
example v1.00 for A4 devices
NEUF-RicohSmartSDK- Client application v1.0 with no
authOff.zip authentication.
NEUF-RicohSmartSDK- Client application v1.0 with
authOn.zip authentication

You can upload package files one at a time using the Upload button on the Files tab in Device
Registration Service web client. Alternatively, you can copy files to the following Device Registration
Service plugin folder:
C:\Program Files (x86)\Nuance\Device Registration Service\Service\Plugins
\NSi.DeviceManagement.Plugins.RicohSOP
To upload files for a single group, make sure that you upload all of the files listed for the group. After you
upload files, you can view the files by selecting Ricoh SOP in the Device Type box on the Files tab. A
named group can be selected for the Application Package option in the device settings. This settings
determines the files that are installed on the MFP that is pointed to by the device Address option.
Related concepts
Working with client packages on page 18
Related tasks
How to upload a Unified Client installation package to DRS on page 20
This procedure describes how to upload Unified Client installation packages downloaded from a Nuance
download portal. An installation package is specified in the Unified Client Device settings.

Application types
Tables in this topic show applications that can be created for different packages.

AutoStore only

Nuance Application Client Installed AutoStore Server Use SSL

AS only Auth OFF ON

AS only Auth OFF OFF

Equitrac only

Nuance Application Client Package Equitrac SSL

EQ only Auth ON N/A - Always uses SSL

Output Manager only

Nuance Application Client Package Output Manager SSL

OM only Auth OFF OFF

OM only Auth OFF ON

OM only Auth ON OFF

303
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Application Client Package Output Manager SSL

OM only Auth ON ON

AutoStore and Equitrac

Nuance Application Client Installed AutoStore Server SSL

AutoStore – Equitrac Auth ON OFF

AutoStore – Equitrac Auth ON ON

AutoStore and Output Manager

Nuance Application Client Installed AutoStore SSL Output Manager SSL

AS-OM Auth OFF OFF OFF

AS-OM Auth OFF OFF ON

AS-OM Auth OFF ON OFF

AS-OM Auth OFF ON ON

AS-OM Auth ON OFF OFF

AS-OM Auth ON OFF ON

AS-OM Auth ON ON OFF

AS-OM Auth ON ON ON

Nuance Unified Client for Ricoh Smart Operation Panel actions reference
Actions that can be performed from the Device Registration Service for a Nuance Unified Client for
Ricoh Smart Operation Panel device. An action can be performed on a single device or on all devices
in a group.
To perform an action, first select a device on the Device tab in the Device Registration Service web
console. Then, in the box at the top of the Details pane, click an available action to perform on the

device and click the run button . To perform an action on all devices in a group, first select the group
folder on the Device tab, and then run the action.

304
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Action Description

Install and Reboot Installs the Nuance Unified Client for Ricoh Smart
Operation Panel on the device. This action first
uninstalls any package already installed on the
MFP, then installs the package associated with the
device configuration, sets required SP mode, and
then restarts the MFP. The reboot may take some
time to complete.
Run the Configure and Reboot action after you
complete this action.
If you expect to wake up the MFP from sleep
mode via a card swipe, you must set this setting:
Service > Screen Features > Screen Device
Settings > Screen device always-connection
Setting See System Configuration Settings on
page 317

Configure and Reboot Updates device configuration for the Nuance

Unified Client for Ricoh Smart Operation Panel
package installed on the device and then restarts
the MFP. This action must be run after you
complete the Install and Reboot action.
The device will be rebooted two times when you
run this action. The Action initially tries to set SP
Mode settings to their default values and applies
the new values, including whether to associate the
Home key with the client, that have been specified
in the Device settings. Warnings that settings
were not configured indicates that the Action was
unable to apply a setting, which you may choose
to manually configure on the physical device.

Uninstall Uninstalls the Nuance Unified Client for Ricoh

Smart Operation Panel on the device.

Reboot Restarts the MFP.

305
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Action Description

Get device settings Gets current SP Mode settings on the device.

Running this Action logs SP Mode settings
and their values to a properties file (with the
.properties extension). The default path to
these properties files is:
C:\Program Files (x86)\Nuance\Device
Registration Service\Service\Plugins
\RXOP-SOP\CLITools\output
The file name of each log includes the IP address
of the device followed by an underscore (_)
and a Universal Time (UT) date-time stamp
(YYYYMMDDHHMMSS). For example:

10.56.59.31_20160802221258.properties
10.56.59.35_20160802221451.properties
10.56.59.35_20160805204754.properties

Each file first lists the day, month, date, local time,
time zone and year followed by one property
setting and value per line in the following format:

#
#Fri Aug 05 16:48:39 EDT 2016
adminAuthKey.file.tools=false
adminAuthKey.network.file=false
adminAuthKey.machine.general=false
adminAuthKey.file=false
userAuthDocumentServer=1
...

The actual settings and values listed in the file

depend on the device.

Set device settings This action sets configurations what were

not completed by the Install and Reboot or
Configure and Reboot actions.
Run this action if you get the following warning
(return code = 0) on completion of either the
Install and Reboot or the Configure and Reboot
action:
Warning: Some configurations not set

306
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for Ricoh Smart Operation Panel Return codes
Nuance Unified Client for Ricoh Smart Operation Panel return codes appear for device actions that you
perform through Device Registration Service.
The following return codes may appear for Nuance Unified Client for Ricoh Smart Operation Panel
history items in the Action History panel in the Device Registration Service Web Client.

Return Code Description

0 Configuration successfully completed.

1 Configuration successfully completed with

message:
Warning: Some configurations not set

100 Client package is installed.

500 General error

501 Application not installed on device

502 Authentication failed

503 Device unreachable

Action Status Codes

The codes in this topic may be displayed after completing an action.

Unified Client App status Scan GUI Service status DRS status message

Installed Installed Installed; Version:

Client: 1.14.189 – Scan
GUI Service: 1.00.00

Installed Not Installed Installed; Version:

Client: 1.14.189 –
Scan GUI Service: Not
installed

Installed Error Installed; Version:

Client: 1.14.189 –
Scan GUI Service: Error
message

Not Installed Not Installed Not Installed

Not Installed Installed Not Installed

Error - Error message

307
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Troubleshooting the Nuance Unified Client for Ricoh Smart

Operation Panel
Issue Cause Solution

Home key on an MFP was not Device configuration may not be You can enable the Home key
enabled by Assign as home implemented yet for a particular manually on an MFP using the
key application Device setting. MFP. following procedure:
• How to enable Home Key
settings on page 309

Need to use the Auth Off client Device configuration may not be You can manually configure the
on the MFP. implemented yet for a particular MFP to use the Auth Off client
MFP. using the following procedure:
• Device Config for AuthOff on
page 310

Need to manually configure SP SP Modes are normally You can manually configure SP
Modes on a device. configured by running Actions on Modes on a device using the
a device. following procedure:
• How to configure SP Mode
settings on page 312

Property files generated during action with Equitrac as print manager

Equitrac — Home=True and Scan=True

Install and Reboot • deviceconfig_tracking_off.properties
• default_deviceconfig.properties
• deviceconfig_to_auth_on_preinstall.properties

Configure and Reboot • deviceconfig_auth_on.properties

• deviceconfig_home_key_on.properties

Uninstall • deviceconfig_tracking_off.properties
• default_deviceconfig.properties

Equitrac — Home=False and Scan=False

Install and Reboot • deviceconfig_tracking_off.properties
• default_deviceconfig.properties
• deviceconfig_to_auth_on_preinstall.properties

Configure and Reboot • deviceconfig_auth_on.properties

Uninstall • deviceconfig_tracking_off.properties

308
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Equitrac — Home=False and Scan=False

• default_deviceconfig.properties

How to enable Home Key settings

Use this procedure to enable the Home key when the Assign as home key application option in the
Device settings fails to enable the Home key on an MFP.
The Home key is disabled by default. This procedure describes how to enable this feature.
Important: This procedure requires working in Service Mode, which is typically performed by a Ricoh
technician.

1. On the SOP device, open the Printer application.

2. Enter SOP Service Mode mode to complete the succeeding steps.
If the SOP Service Mode screen does not appear, the foreground app may be covering the SOP
Service Mode screen. Try closing the foreground app by pressing the Return or Home button.
3. Press SYSTEM.

Figure 43: SOP device System Service settings

4. Press Screen Device Settings.
5. Press Home Key Settings.
This displays the Home Key settings screen.

309
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. Press Home Key Application.

7. On the Home Key Application screen, select the application that starts when a user presses the
Home key.
By default, this screen lists the Launcher, which is the Ricoh Home key application.

8. Log out of Service Mode.

9. Reboot the device.

Device Config for AuthOff

Follow this procedure to use the Auth Off client on the MFP. You should normally need to do this if it was
not completed automatically by DRS.
1. Login [User Tools] as admin.

310
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. In User Authentication Management, press Off to turn off user authentication.

3. For Machine Action When Limit is Reached, press Allow Continue Use to not stop jobs when a
limit is reached.

4. For Tracking Permission, press Off to turn off print tracking.

311
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure SP Mode settings

This procedure describes how to configure Service Provider (SP) modes. The SP Mode settings are
normally configured by the Configure and Reboot Action Action. You can use this procedure to
configure settings manually when a device does not allow Device Registration Service to configure SP
Mode settings through the Action.
Important: This procedure requires working in Service Mode, which is typically performed by a Ricoh
technician.

1. On the Home screen, go to Printer (scroll screen) and press the Printer icon.
2. Enter SOP Service Mode mode to complete the succeeding steps.
3. Press System Sp (press 0 to change bit from 0 to 1, then # to save).
4. Press SP Direct.

312
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. In SP Direct type 5401230, then type #.

6. Set the LSB to 1 (by pressing zero 0 on keypad.
The last digit should now be a 1.
7. Type # to save your changes.

8. Navigate to User Tools > Machine Features > System Settings > Administrator Tools >
Administrator Authentication Management, and on the User Management tab, set Admin.
Authentication to On.

313
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

9. Navigate to User Tools > Machine Features > System Settings > Administrator Tools > User
Authentication Management Setting, and on the Custom Auth. tab, enable LDAP authentication.

The label LDAP authentication in step 8 will be changed to Custom authentication after the
machine is rebooted.
10.Enable Machine action when limit is reached in System Settings (Administration tools).
Set this to Stop Job or Finish Job and Limit.

314
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

11.Set Auto Delete User in Address Book to On in System Settings (Administration tools).

12.Enable the network by setting User tools > Login > Exit > Screen Features > Interface Settings >
Set to Machine Network.

315
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The authentication logic customization feature becomes valid when the following condition is
satisfied.

13.Log in as machine admin and navigate to User Tools > System Settings > Administrator Tools >
Enhanced Print Volume Use Limitation.

14.Turn on Tracking Permission.

Paper type setup

If you notice that your tracking and pricing for copies is different than expected, please ensure you have
the paper type set to Tray 1 and Plain Paper. Follow these steps:
1. Open a web browser and enter http://<MFP IP Address> in the Address field. The device web
page opens.
2. Click Login and enter your administrator User Name and Password. The Web Image Monitor page
opens.

316
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The Web Image Monitor page may differ in appearance and location of functions by device.
The basic functionality remains the same.

3. Navigate to Device Management > Configuration. The Configuration options display.

4. Under Device Settings, click Paper. The Paper options display.
5. Under Tray 1, from the Paper Weight drop-down list, select any of the Plain Paper options.
6. If you are using the Bypass Tray, ensure it is also using this setting.
7. Click OK.

System Configuration Settings

CAUTION: When installing Equitrac, you must use the settings listed under Auth On. Auth Off
settings handle other configurations of the Unified Client.

Configuration Path Auth On Notes

Service > Screen Features Either
> Screen Device Settings >
Home key settings > Home
key application
Service > Screen Features Active Needed for card reader auto-
> Screen Device Settings wakeup
> Screen device always-
connection Setting
User Tools > Machine On
Features > System Settings
> Administrator Tools >
Administrator Authentication

317
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configuration Path Auth On Notes

Management > Admin.
Authentication
User Tools > Machine Administrator Tools
Features > System Settings
> Administrator Tools >
Administrator Authentication
Management >Available
Settings
User Tools > Machine On
Features > System Settings
> Administrator Tools > Auto
Delete User in Address Book
User Tools > Machine On
Features > System Settings
> Administrator Tools >
Enhanced Print Volume Use
Limitation > Stop Printing
User Tools > Machine On
Features > System Settings
> Administrator Tools >
Enhanced Print Volume
Use Limitation > Tracking
Permission
User Tools > Machine Stop Job
Features > System Settings >
Administrator Tools > Machine
action when limit is reached
User Tools > Machine None
Features > System Settings
> Administrator Tools > User
Authentication Management
> Custom Auth > Available
Functions Copier
User Tools > Machine Not Programmed
Features > System Settings
> Administrator Tools > User
Authentication Management >
Custom Auth > LDAP Servers
User Tools > Machine None
Features > System Settings
> Administrator Tools > User
Authentication Management
> Custom Auth > Other
Functions
User Tools > Machine Entire
Features > System Settings
> Administrator Tools > User

318
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configuration Path Auth On Notes

Authentication Management
> Custom Auth > Printer Job
authentication
User Tools > Machine N/A
Features > System Settings
> Administrator Tools > User
Authentication Management >
OFF
User Tools > Screen Features Machine Network
> Interface Settings

Finalize the Uninstallation

If, after the uninstallation is complete, the Nuance Launcher icon remains on the Ricoh Smart Operation
Panel Home screen, do this to remove it:
1. Login to the device with administrator credentials.
2. Ensure that you are on the Ricoh Smart Operation Panel Home screen, where the Nuance Launcher
icon appears.
3. Press down and hold the Nuance Launcher icon. After a few seconds, a small trash can icon
displays on the screen.
4. Still pressing down on the icon, drag it into the trash can.

Restarting the device

A restart of the device is recommended after installing or uninstalling new software. Follow these steps:
1. Locate the physical on/off switch of the device, then press until the device screen displays a dialog
indicating the device is shutting down.
You can then release the button. The shutdown process may take as long as 7 minutes.
Note: Once the screen shuts down, the device’s blue LED indicator light continues to flash. The
device is not fully shut down until this light stops flashing.

2. Once the device is fully shut down, press the on/off button again. The screen indicates the startup is
in progress.
Depending upon the device’s setup, the main display will either show the Nuance Unified Client for
Ricoh Smart Operation Panel login screen, or if the embedded solution is not installed, the standard
Ricoh Smart Operation Panel Home screen with option icons.

Device Logging
Device logs can be collected. The client creates a debug bundle which includes detailed logs which
can be used for troubleshooting. The logs can be sourced either by inserting an SD card into the Smart
Operation Panel, which will then
1. Locate the physical on/off switch of the device, then press until the device screen displays a dialog
indicating the device is shutting down.
You can then release the button. The shutdown process may take as long as 7 minutes.

319
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Once the screen shuts down, the device’s blue LED indicator light continues to flash. The
device is not fully shut down until this light stops flashing.

2. Once the device is fully shut down, press the on/off button again. The screen indicates the startup is
in progress.
Depending upon the device’s setup, the main display will either show the Nuance Unified Client for
Ricoh Smart Operation Panel login screen, or if the embedded solution is not installed, the standard
Ricoh Smart Operation Panel Home screen with option icons.

320
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for

Samsung

Overview of the Nuance Unified Client for Samsung

The Nuance Unified Client for Samsung is a web-based client that provides AutoStore capture
functionality on Samsung XOA MFP devices.
When a user starts the Nuance Unified Client for Samsung on a device, the client connects to the
embedded web server hosted by AutoStore. The embedded web server uses the MFP device IP
address to retrieve device configuration data from Device Registration Service. This data determines
how the Nuance Unified Client for Samsung behaves and how it contacts the AutoStore server.
The following figure illustrates the architecture for a system that includes the Nuance Unified Client for
Samsung:

321
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Checklist: Nuance Unified Client for Samsung implementation

This implementation check list covers aspects deploying the Nuance Unified Client for Samsung to
devices from the Device Registration Service web client.
This checklist should evolve based on the experience you gain from performing deployments. You might
also want to perform custom checks that are based on a specific aspect of your network architecture or
environment.

Table 7: Unified Client Deployment Checklist

Check Description See

Confirm that your system meets • Requirements on page 323

requirements.

Configure Samsung in an • Samsung component help in

AutoStore workflow using the AutoStore Process Designer.
AutoStore Process Designer.

Add a DRS application for • Add an application

Nuance Unified Client for • Nuance Unified Client
Samsung. for Samsung application
properties on page 323

Add or import a Nuance Unified • Add a device

Client for Samsung device. • Import a device
• Nuance Unified Client for
Samsung device properties
on page 324

Install, uninstall, or update • Nuance Unified Client for

settings for Nuance Unified Samsung actions reference
Client for Samsung. on page 325

322
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Requirements
The table in this topic details system requirements for the Nuance Unified Client for Samsung.

Requirement Description
AutoStore The following are required if capture with
AutoStore is enabled in Device Registration
Service.
• Version 7.0 SP1
• Licensed for Samsung capture component
• Task configured with the Samsung capture
component

Supported devices • Nuance Supported Device Search: Samsung

Reference
This section describes options for the Nuance Unified Client for Samsung objects and documents return
codes.

Nuance Unified Client for Samsung application properties

The Samsung application profile defines the address and port settings for the AutoStore.
These options may be viewed by creating a Samsung XOA application on the Applications tab of the
Device Registration Service web application. See Working with Applications on page 11.

Property Description

Name Name A name to label the DRS application.

Application Type Specifies the device application type. In the list,

click Samsung XOA.

AutoStore Server Address The IP address, computer name, or DNS name

of the machine that hosts AutoStore Server. The
default is the local IP address. This option is
required.
Device actions use this address.

323
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
AutoStore Server Port The port number used by the web application. The
default is 3349.
Verify that this port number matches the port
number that you specified when configuring
AutoStore. The specified port number is
specified by the Web Server Port setting on the
Preferences tab of the Samsung component
settings in AutoStore Process Designer. If this
value does not match the Web Server Port
setting for the Samsung component in AutoStore
Process Designer, a Web page not available
message appears on the device panel when a
user presses the application button.

Application Timeout The time in seconds after which the Nuance

Unified Client for Samsung will timeout. The
default is 60 seconds.

Nuance Unified Client for Samsung device properties

Nuance Unified Client for Samsung device properties are configured in the Device Registration Service
web console. When configured for a device group, they can be propagated to any device in the group.

These parameters define the device settings. Click the edit button to edit the parameters for a
device. Click the save button to save changes to the parameters or click the cancel button to
discard changes.

Option Description

Name The name of the Nuance Unified Client for

Samsung device or device group.

Address The IP address or DNS address of the Samsung

device.
Note: This is a device only parameter
and will not be displayed when configuring
parameters for a device group.

Username The administrator user name for the Samsung

device. The default is "admin".
Note: Username is not required to perform
a selected action on the device.

Password The administrator password for the Samsung

device. The default password is none.

324
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Application The application that is associated with the
Samsung device or device group.

Device Group Click a group name in this box to change group

membership. When a device is a member
of a group in can optionally inherit device
settings defined for the group. This allows you
to simultaneously manage settings for multiple
devices. Select the [Devices] option in this list to
entirely remove a device from group membership.

Enable Scan Set this to True to enable the AutoStore scan

functionality. The default value is True.

Nuance Unified Client for Samsung actions reference

Actions that can be performed from the Device Registration Service for a Nuance Unified Client for
Samsung device.
To perform an action, first select a device on the Device tab in the Device Registration Service web
console. Then, in the box at the top of the Details pane, click an available action to perform on the

device and click the run button .

Action Description

Update Settings Choose this to update changes to the UI address

or credentials.

Install Application Installs the Nuance Unified Client for Samsung on

the device.

Uninstall Application Uninstalls the Nuance Unified Client for Samsung

on the device.

Return codes
The following table describes the return codes that can appear in the Device Registration Service
Action History pane for a Nuance Unified Client for Samsung device or device group.

Return Code Description

101 Successful Nuance Unified Client for Samsung

registration.

102 Successful authentication registration.

104 Successful Nuance Unified Client for Samsung

unregistration.

325
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return Code Description

105 Successful authentication unregistration.

301 Device is offline.

302 Device is online.

303 Device is online and one of three applications is

registered.

304 Device is online and two of three applications are

registered.

305 Device is online and all three applications are

registered.

500 Nuance Unified Client for Samsung device

registration failed.

501 Nuance Unified Client for Samsung device

unregistration failed.

502 Unable to proceed. Please restart device.

503 Invalid password. Please retry login.

504 Unable to connect to device. Please restart

device.

505 Maximum registered applications exceeded.

Remove unused applications and retry.

506 Device is locked. Retry later.

507 Logo icon file does not exist. Contact Nuance

Communications Support.

508 The device solution key file not found. Contact

Nuance Communications Support.

509 Invalid Output Manager server address. Enter

correct server address and retry.

510 Registration was unsuccessful on the device.

511 Device does not support iOption. Add iOption or

use the Native Scan connector.

326
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return Code Description

512 Invalid password. Enter the valid password and
retry.

513 Unregistration failed because the Nuance Unified

Client for Samsung is not registered.

515 OpenAPI SSL is not enabled on the device.

Authority registration requires OpenAPI SSL.
See Device Registration Service Help to enable
OpenAPI SSL.

517 Registration failed due to insufficient device

memory.

518 Invalid AutoStore server address. Enter the valid

address and retry.

519 Invalid web application port number. Enter the

valid port number and retry.

Troubleshooting
• Authentication connection errors on page 327
• Unified Client application connection errors on page 328
• Unified Client resets too quickly on page 329
• Unified client registration error messages on page 329
• Authentication registration error messages on page 331
• Unified Client Unregistration error messages on page 332
• Orphan Unified Client button on the device on page 332

Authentication connection errors

Follow these steps to resolve an authentication connection error on a device:
• Verify that the AutoStore and Output Manager servers are started.
• Verify that the port specified in the application settings for a device in the Device Registration Service
matches the port specified in AutoStore or Output Manager:
• If you are using AutoStore or both AutoStore and Output Manager, confirm the Web Application
Port value in the application settings matches the AutoStore component port setting
• If you are only using Output Manager, confirm the Web Application Port value in the application
settings matches the Server Port value on the Clients tab in the Output Manager Administration
application.
Nuance Unified Client for Samsung application properties on page 323 provides more information
on application settings.

327
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Verify that the Use SSL for Web Application setting specified in the application settings for the
device in the Device Registration Service matches the Use SSL setting in AutoStore or Output
Manager:
• If you are using AutoStore or both AutoStore and Output Manager, confirm the Use SSL for Web
Application setting in the application settings matches the Use SSL setting for the AutoStore
component.
• If you are only using Output Manager, confirm the Use SSL for Web Application setting in the
application settings matches Use SSL on the Clients tab in the Administration module of Output
Manager.
Nuance Unified Client for Samsung application properties on page 323 provides more information
on application settings.
• Test the Authority Application by creating a dummy device without registering it on an actual device
in Device Registration Service and then typing the following address in a web browser:
http://server_IP_address:3348/Authority
This assumes that Device Registration Service uses default web application port 3348 and the Use
SSL value is False.
• Test the OpenAPI Authority by typing the following address in a web browser:
http://server_IP_address:13353
This assumes the OpenAPI authentication uses default port 13353 and the Use SSL value is set to
False.
• Restart the device and the AutoStore or Output Manager service.
• Verify that there is no firewall software or hardware blocking the specified port and that IP routing has
been set up to enable communication on this port.

Unified Client application connection errors

• Verify that the AutoStore and Output Manager servers are started.
• Verify that the port specified in the application settings for a device in the Device Registration Service
matches the port specified in AutoStore or Output Manager:
• If you are using AutoStore or both AutoStore and Output Manager, confirm the port used by the
device in Device Registration Service matches the Web Server Port setting in the Preferences
for the Samsung XOA component in AutoStore Process Designer.
• If you are only using Output Manager, confirm the Web Server Port setting in the application
settings matches the Server Port setting on the Clients tab in the Output Manager Administration
application.
Nuance Unified Client for Samsung application properties on page 323 provides more information
on application settings.
• Verify that the Use SSL for Web Application setting specified in the application settings for the
device in the Device Registration Service matches the Use SSL setting in AutoStore or Output
Manager:
• If you are using AutoStore or both AutoStore and Output Manager, confirm the Use SSL for Web
Application setting in the application settings matches the Use SSL setting for the AutoStore
component.

328
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• If you are only using Output Manager, confirm the Use SSL for Web Application setting in the
application settings matches Use SSL on the Clients tab in the Output Manager Administration
application.
Nuance Unified Client for Samsung application properties on page 323 provides more information
on application settings.
• Test the Authority Application by creating a dummy device without registering it on an actual device
in Device Registration Service and then typing the following address in a web browser:
http://server_IP_address:3348/Authority
This assumes the Device Registration Service uses default web application port 3348 and the Use
SSL setting is False.
• Test the OpenAPI application by typing the following address in a web browser:
http://server_IP_address:13351
This assumes the OpenAPI application port uses default port 13351 and the Use SSL setting is
False.
• Restart the device and the AutoStore or Output Manager service.
• Verify that there is no firewall software or hardware blocking the specified port and that IP routing has
been set up to enable communication on this port.

Unified Client resets too quickly

Problem description When the user is working on the Nuance Unified

Client for Samsung screen, the screen resets after
one minute, even if the user pressed buttons on
the screen within the last minute.
Cause The Auto Reset System setting in the MFP is set
to 1 minute.
The Auto Reset Setting controls the timeout
for the MFP client. This timeout is not reset
when buttons are pressed in a browser-based
application such as the Nuance Unified Client for
Samsung.
Solution Increase the device timeout interval to 3 minutes..

Unified client registration error messages

Code Message Comments

502 Unable to proceed. The device may be in faulted

Please restart device. state or the device does not
support OpenAPI. If the device is
started and this error still occurs,
contact Nuance Communications
Support.

329
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Code Message Comments

503 Invalid password. Please Verify that you enter the correct
retry login. device admin password in the
device Details pane in Device
Registration Service.

504 Unable to connect to

device. Please restart
device.

505 Maximum registered

applications exceeded.
Please remove unused
applications and retry.

506 Device is locked. Please Verify that the device is not

retry later. in authentication mode or
application mode.

507 Logo icon file does not Contact Nuance

exist. Contact Notable Communications Support.
Solutions Support.

508 Device solution key Contact Nuance

file not found. Contact Communications Support.
Notable Solutions
Support.

509 Invalid Output Manager The Output Manager server

server address. Enter address is blank. Enter the
correct server address Output Manager server on the
and retry. Applications tab in Device
Registration Service or set
Enable Print Release as False
in the device Details pane.

511 iOption not supported

on device. Add iOption
or use the Native Scan
connector.

512 Invalid password. Enter Reenter your credentials using a

the valid password and valid password.
retry.

330
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Code Message Comments

518 Invalid AutoStore server The AutoStore server address
address. Enter the valid is blank. Enter the AutoStore
address and retry. server on the Applications tab
of Device Registration Service or
set Enable Scan as False in the
device Details pane.

519 Invalid Web application The Web Application Port

port number. Enter the setting is blank or contains a
valid port number and negative number. Enter a valid
retry. port number forWeb Application
Port on the Application tab of
Device Registration Service.

Authentication registration error messages

Registration requires that the device is on and functioning normally. Ping the device or access
PageScape to verify that the device is communicating with the network. The AutoStore and Output
Manager services do not have to be running when you perform the registration.

Code Message Comments

502 Unable to proceed. The device may be in a faulted

Please restart device. state or the device does not
support OpenAPI. If the device is
started and this error still occurs,
contact Nuance Communications
Support.

503 Invalid password. Please Verify that you enter the correct
retry login. device administrator password.

504 Unable to connect to

device. Please restart
device.

506 Device is locked. Please Verify that the device is not

retry later. in authentication mode or
application mode.

509 Invalid Output Manager The Output Manager server

server address. Enter address is blank. Either enter the
correct server address Output Manager server address
and retry. on Applications tab of DRS
or set Enable Print Release
as False on Devices tab of the
Device Registration Service.

331
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Unified Client Unregistration error messages

Unregistration requires that the device is on and functioning normally. Ping the device or access
PageScape to verify that the device is communicating with the network.

Code Message Comments

502 Unable to proceed. The device may be in a faulted

Please restart device. state or the device does not
support OpenAPI. If the device
is started and this still occurs,
contact Nuance Communications
Support.

503 Invalid password. Please Verify that you enter the correct
retry login. device administrator password.

504 Unable to connect to

device. Please restart
device.

506 Device is locked. Please Verify that the device is not

retry later. in authentication mode or
application mode.

513 Unregistration failed There is no registered Nuance

because no unified Unified Client for Samsung
client has been application.
registered.

Orphan Unified Client button on the device

Use the Samsung component to remove the button:
1. Open the Samsung component Properties dialog box.
2. Click Device Manager.
3. Enter values for IP Address and Admin password and click the Application list button.

332
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Select the Unified Client application and click Delete.

333
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

334
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Equitrac Embedded for

Samsung XOA-Web v1.0

Overview of the Equitrac Embedded for Samsung XOA-Web

v1.0
The Equitrac Embedded for Samsung XOA-Web v1.0 provides native copy, scanning, faxing and secure
printing on specific Samsung manufactured Multi-Function Printers (MFPs). Embedded on the MFP,
Equitrac Embedded for Samsung XOA-Web v1.0 controls access to the enabled device and acts as the
gateway for Nuance functionality. Users must authenticate to gain access to Nuance-controlled device
functions.
Equitrac Embedded for Samsung XOA-Web v1.0 communicates with Nuance servers and tracks user
activity. During a user session, device activity is captured by the Equitrac server.
The following panel sizes are supported by Nuance: 4.3" or 7".
Note: This document provides examples for 7” screen panel.

Equitrac Embedded for Samsung XOA-Web v1.0 Features

Equitrac Embedded for Samsung XOA-Web v1.0 supports the following features:
• Authentication — Requires users to enter valid authentication information to unlock the device
functions. Users can enter their authentication data via the device panel, or by using a valid
authentication card.
• Card self-registration — Allows users to associate an unassigned card with their user credentials.
Once associated, each time the user swipes the card, the system automatically recognizes the card
and associated user. See Configuring Card Self-Registration for instructions.
• Follow-You Printing® — After successful login at the device, the user can access the virtual print
queue to "pull" a print job to this device. Through the Follow-You screen on the device, users can
see a list of documents in the queue, then select, delete, or release documents for printing. See
Enabling Secure Printing for configuration instructions, and Using Follow-You Printing for end-user
instructions.
• Native Copy, Scan and Fax — Allows users to use native device functions. Apart from copying
and faxing, users can scan a document and email it to their own address, and optionally to other
addresses via the CC field. Users can specify scan options (for example, duplex, color, size) and
document format prior to initiating a scan. See Using Native Copy, Fax and Scan for more details.

335
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Supported Devices
Equitrac Embedded for Samsung XOA-Web v1.0 is compatible with the following Samsung models:
This content is pending additional review and will be added as soon as it is available.

Table 8:

Device Model Screen Size BW/ Firmware version

Color

proXpress C3060FR 4.3 inch Color V3.00.05.04 _0401179_02

Mutli Xpress XMX3280NR 7 inch Color V3.00.08.07 _CBR01.01.082918

Multi Xpress XMX3220NR 7 inch Color V3.00.08.07 _CBR01.01.082918

Mutli Xpress K3300NR 7 inch Color V3.00.08.07 _CBR01.02.101811

Mutli Xpress K3250NR 7 inch Color V3.00.08.07 _CBR01.02.101811

For the latest list of supported Samsung models, consult your local Samsung representative or refer to
Equitrac Embedded for Samsung Devices (Samsung Supported Device Search for Equitrac Office).

Supported Card Readers

Equitrac Embedded for Samsung XOA-Web v1.0 supports Equitrac USB external card readers,
Samsung-supported third-party card readers, as well as a variety of other third-party USB card readers.
For a list of supported readers, refer to the Equitrac supported card readers data sheet at Nuance web
page (https://www.nuance.com).

Multi-Language Support
The Equitrac Embedded for Samsung XOA-Web v1.0 installation program and configuration features
are available in English only.
Multi-language support for Equitrac Embedded for Samsung XOA-Web v1.0 interface includes support
for the languages listed below. The language is selected automatically based on the device language. If
the device language is not available, English is used by default.
The following languages are supported: Czech, Danish, Dutch, English, Finnish, French, German,
Hungarian, Italian, Korean, Norwegian, Polish, Portuguese (Brazilian), Russian, Simplified Chinese,
Spanish, Swedish, Thai and Turkish.

Requirements
System requirements for any machine hosting the Equitrac server components (Core Accounting
Server, Device Control Engine) are available in the Equitrac Office/Express Installation Guide.
The following components are required for installing the Equitrac Embedded for Samsung XOA-Web
v1.0 software:
• Equitrac Office or Equitrac Express version 5.7 or later with all available hotfixes installed
• Device Registration Service 7.9 with SamsungXOAWeb.zip file
• Administrative access to the device
• Administrative access to Windows and associated servers

336
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Document Conventions
This guide does not provide installation or configuration details for network accounting software (except
in the case of specific upgrades required to function with the embedded application), control terminals or
your device. For more information about these products, see the relevant product documentation.

Software and Firmware

Equitrac Embedded for Samsung XOA-Web v1.0 is a software product that is installed on supported
devices. In this document, the term firmware refers to the device system firmware and not to Equitrac
Embedded for Samsung XOA-Web v1.0 software.

Additional Documentation
You may need to refer to one of the following documents when performing server-side configuration
tasks. These documents are provided with your Equitrac product software, and are installed
automatically with any server-side component in the Program Files\Equitrac\Express
\Documentation folder.

Table 9:

Guide When to refer to this guide

Equitrac Office/Express Planning Guide Before installing Equitrac Office or Express, use
this guide to select the appropriate combination
of product variables to support the needs of your
institution or organization.

Equitrac Office/Express Installation Guide Use this guide to perform an initial installation or
upgrade.

Equitrac Office/Express Administration Guide After installing Equitrac Office or Express, use this
guide to configure advanced options for use on
your campus or in your organization.

Device Registration Service Installation Guide Use this guide to perform an initial installation,
configuration or upgrade of Device Registration
Service.

Installation and Configuration

This section describes how to install Equitrac Embedded for Samsung XOA-Web v1.0 on supported
Multi-Function Printers (MFPs) and configure the product for initial startup (client 1.0.4677 is
recommended).
In addition to this guide, ensure that you have documentation related to your Equitrac product suite,
documentation for your device and the DRS Installation Guide.
Note: This guide assumes that you are installing the Equitrac products (servers and embedded
applications) in a Windows network environment. This guide does not provide any information for
third-party software (including databases) or operating system support.

337
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Prerequisites: Before You Install

You must have administrative access to both the devices and to the network computer hosting the
Equitrac server components to install and configure Equitrac Embedded for Samsung XOA-Web v1.0
application. Note that the administrative credentials for the device may differ from the Windows network
credentials with assigned administrative rights.
Your Samsung technician will provide the default administrative credentials for the device.
Before you begin the installation:
• Ensure you have met the requirements for your Multifunction Printers (MFPs) and Equitrac Office/
Express installation. See Requirements for more information.
• Install or update to, license, and configure Equitrac Office/Express 5.7 or later before installing
Equitrac Embedded for Samsung XOA-Web v1.0. For more information, see your Equitrac Office/
Express documentation.
• Install or update to Device Registration Service 7.9.
• Download the appropriate Equitrac Embedded for Samsung XOA-Web v1.0 installation files for your
device and copy them to a shared network location.
• Ensure that the Equitrac Office/Express hotfixes are installed on the server.
• Choose the Equitrac Office/Express Core Accounting Server (CAS) with which System Manager is
associated.
• Obtain the IP address of the Samsung devices where you will install the Equitrac Embedded for
Samsung XOA-Web v1.0.

Installation Workflow
To install and configure Equitrac Embedded for Samsung XOA-Web v1.0 and its server components,
you must have administrative access to the machine hosting the Equitrac server components. Default
administrative credentials for the device are provided by your device technician; server credentials by
your network administrator.
Note: Complete the preparation steps described in Prerequisites: Before You Install on page 338

This installation is configured by the Device Registration Service (DRS). DRS is a common interface that
allows you to install and manage Nuance clients on the device. The client installation in DRS involves
three steps:
1. Download the client package from Nuance to a local drive and then upload them to DRS. See
Working with client packages on page 18.
2. Create the DRS Application. See Working with Applications on page 11.
3. Create the DRS Device. See Working with Devices on page 13.
You can create a Device group to apply similar settings to multiple devices. See Working with Device
Groups on page 17.
4. Enable the XOA Web feature on the device. See How to enable the XOA Web feature on a Samsung
device on page 339.
This feature must be selected to allow installation of the client on the device.
5. Run a Device Action to install the client on the device. See Actions Reference on page 367
For more information, see Settings Reference.

338
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to enable the XOA Web feature on a Samsung device

In order to install the Nuance Samsung XOA Web client on the device, you must first enable the XOA
Web feature on the device.
The XOA Web feature is enabled in the Feature Management settings on a Samsung device.
1. Connect to the device through the SyncThru™ Web Service embedded web server on the device.
2. After you log in, navigate to the Security settings.
3. Expand System Security and click Feature Management.
4. In the Feature Management settings, select the XOA Web check box.

Disabling Printing from USB

Optionally, the user can disable printing from the USB printing application via Samsung SyncThru
Web Service (SWS). The Samsung SWS is a web interface that is available on most network and
wireless capable MFPs. It provides an easy way to set up and modify the settings of the printer from any
computer that is connected to the same LAN or network.
To access the Samsung SWS and disable printing from the USB, complete the following steps:
1. Obtain the IP address of your MFP.
2. Access a computer that is connected to the same network as your printer. Open an internet browser,
type your IP address and press Enter.
3. The Samsung SWS web page appears. Click the Login link at the top right of the web interface.
This will bring up the login screen. The default user name is 'admin' and the default password is
'sec00000'. Fill in the required fields and click Login.
4. Go to Maintenance > Application Management and under Application double-click USB (clicking
USB only once will list application properties).
5. A Setting window appears. Set State to Disable and click Apply.
6. Logout from Samsung SyncThru Web Service.

339
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

USB Card Readers

Equitrac USB card readers are typically automatically detected by the device upon startup. There
is no device or server configuration required for Equitrac Embedded for Samsung XOA-Web v1.0
to recognize card reader hardware. Some server configuration, however, is required to ensure they
function properly for Equitrac Embedded for Samsung XOA-Web v1.0. Some card readers can be
configured to detect multiple card types. If your card reader supports more than one type of card, we
recommend configuring it for all possible options, as this may improve the sensitivity of the reader to
provide a better user experience, as well as prevent the need for future reconfiguration if card types
change.
Note: Card readers within authentication workflows must be configured on the server in System
Manager. Otherwise, card readers will not be recognized. For detailed information about configuring
authentication workflows, see the Equitrac Office/Express Administration Guide.
Note: Equitrac USB card readers are supported in keyboard emulation mode. To convert your
Equitrac USB card reader to keyboard emulation mode, contact Equitrac service for details and help.

The following Equitrac USB Card Readers are supported for 4.3- and 7- inch screen: Equitrac ID Card
Readers (generation one and generation two) and RFIdeas (third-party card reader).

Disconnect or reconnect the USB Card Reader

Many Samsung devices have more than one available USB port.
Third-party card readers can use any other USB port on the panel. There are no special hardware
considerations when adding or removing a card reader. To remove a card reader, simply unplug it. To
add a card reader, plug it into the correct port.

340
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Server Side Configuration

Server-side configuration involves specifying whether you want print release only, native copy only, or
both print release and native copy. This section includes instructions for configuring the Equitrac server
for the embedded application. This workflow assumes you have already registered the physical device
in Equitrac System Manager and, if necessary, enabled secure printing at the print queue level, as
detailed in the Equitrac Office/Express Administration Guide. When performing a bulk install, the steps
outlined in this section need to be completed once for each device.

Licensing Equitrac Embedded for Samsung XOA-Web v1.0

Each Equitrac Embedded for Samsung XOA-Web v1.0 installation requires a license applied in the
Equitrac System Manager. You must obtain one license per device, or purchase a license pack that
contains enough licenses for all of the devices you want to enable for use. You can buy single licenses
or license packs as needed.
Third-party or other native scan applications do not require separate licenses from Equitrac.
Once you obtain the licenses, you need to activate them in the Equitrac System Manager. By default,
the System Manager resides on the machine that hosts the accounting server. However, System
Manager may be installed on any machine on the network that has a connection to the CAS.
1. Open System Manager by selecting Start > All Programs > Equitrac Office/Express > System
Manager.
2. In the Select Accounting server dialog, choose the CAS with which Equitrac System Manager is
associated, then click Connect. If the server is not listed, enter IP address in the server field.
Note: You must use IP address as certificates use IP address by specification. MFPs should be
also configured to use DWS IP address (DRS device/application configuration).

3. When System Manager opens, click Licensing in the left menu pane.
4. Under Current tasks, click Add license, or click <Add...> in the right pane.
5. When the Equitrac activation window opens, click Next to begin the activation process.
6. Enter the serial number for each components you want to activate. These serial numbers were
supplied with your software. After you enter each complete serial number, click Add to add it to the
list, then enter additional serial numbers as required.

341
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. When all numbers are entered, click Next.

8. Select Automatic online activation or Manual activation, and click Next.
Note: If you do not have a connection to both the Internet and CAS, choose Manual activation.

9. For Manual activation, do the following:

a) Contact Nuance Customer Support at Contact Nuance (https://nuanceimaging.custhelp.com/app/
imaging/contact/) or by telephone to obtain the corresponding activation codes.
b) After receiving the required activation codes, click Finish to continue.
c) On the Add licensing Information dialog box, enter the activation code, and click Add.
d) The activated software license appears in System Manager.
10.For Automatic online activation, do the following:
a) In the embedded device licensing screen, select Samsung from the Manufacturer list, then click
Next.
b) Follow the Activation wizard prompts to provide contact information. If you have already
registered one or more Equitrac components, the Activation wizard fills the form with previously-
collected data.
c) The Activation wizard displays a Collecting information... message while retrieving system data.
If you want to omit technical details about your system, click the Show technical details button
and select the information you do not want to transmit. You must transmit the following:
• Accounting server serial number
• Domain-qualified print server name
• Organization name as registered in Windows
• Fully-qualified server DNS name
d) When the Activation wizard is ready to transmit the information, review the collected data. Choose
whether to send optional data with your activation request.

342
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The Activation wizard transmits the data using an HTTP connection to the Equitrac
activation server. If the connection fails, the Activation wizard prompts for verification that
you have configured the default gateway correctly, and that the Internet is accessible from
this machine. You can retry or cancel the activation request at this point. If you cancel, the
Activation wizard prompts you to use manual activation instead
e) Once the Activation wizard sends the activation data and Equitrac returns the activation code, the
Wizard automatically records the license activation in System Manager, and displays a summary
of the activation results:
• Activation code
• Description
• Serial number
• Status (Invalid (the serial number is invalid), Denied (the serial number was valid but not
accepted) or Success)

If the License is Invalid

If the status is Invalid, ensure that you entered all serial numbers and activation codes precisely. Each
component requires a separate license (unless you purchased a suite license).
If the issue persists, contact the Equitrac Customer Support Center to resolve this issue.

If the Serial Number is Denied

If the status is denied, the serial number may already be registered to a different system ID. Contact
the Equitrac Customer Support Center to resolve this issue. Switch to the Assignment View in System
Manager, to see the number of licenses purchased and the number of licenses used.

Configuring Equitrac Embedded for Samsung XOA-Web v1.0 Embedded

Device
There are two methods of registering Equitrac Embedded for Samsung XOA-Web v1.0 devices in
System Manager:
• Automatic creation (the default method)
• Manual registration and configuration.

Automatically Creating Equitrac Embedded for Samsung XOA-Web v1.0 Embedded

Devices
Equitrac Office/Express automatically creates Equitrac Embedded for Samsung XOA-Web v1.0 devices
if you have applied the licenses first, and have already configured the device with the location of the
DCE.

Note: You can rename the auto-created entries as needed using terms and descriptions appropriate
for your organization by right-clicking on an entry and selecting Edit from the menu.

343
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Manually Configuring Equitrac Embedded for Samsung XOA-Web v1.0 Embedded

Devices
The embedded device configuration includes enabling SDR and release behavior, as well as copy and
scan tracking on a per-device basis. To manually configure how each Samsung device is controlled by
Equitrac, do the following:
1. Open System Manager and select Devices to display the devices registered in System Manager.
2. Locate the physical device hosting the Equitrac Embedded device and select the embedded device.

The default Name and Description for the embedded device can be changed. The auto-create
process fills in the Server and Serial number fields. Do not change these values.
3. Under Card reader select the HID decoding from the list.
For details on HID decoding, see the Equitrac Office/Equitrac Express Administration Guide.
4. Click Pricing to configure pricing at the embedded device level.
You can create price lists for each device function, and assign them as the default for all embedded
devices, or you create price lists on a per-device basis. For details on configuring price lists, see the
Equitrac Office/Equitrac Express Administration Guide.
5. To override the default tracking options for the particular device, click the link beside Tracked
activities.
a) In the Embedded device configuration dialog, select the Override default tracking options
check box to select the options you want track
b) Click OK.
6. If you have defined Rule sets in System Manager, select one from the list to apply to this embedded
device.
For more information on creating rule sets, see the Equitrac Office/Equitrac Express Administration
Guide.
7. Select a Prompt for billing code option from the list to configure billing codes by device.

344
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Default This option uses the billing code settings from
System Manager > Configuration > User
interaction > Session flow.
Prompt This option prompts the user for a billing code
even if billing code prompts are not enabled
globally.
Do not prompt This option disables the billing code prompts
even if they are enabled globally.

For more information on globally configuring billing code prompts, see the Equitrac Office/Equitrac
Express Administration Guide.
8. To enable the SDR features, select the Enable secure document release check box. Specify how
the Equitrac Embedded application will handle Release behavior for documents at the device:
Option Description
First is released Releases only the first document in the user’s
queue.
Prompt Prompts the user to release all or select
documents for that user.
Release all at login Releases all queued documents for the current
user automatically after the Follow-You button is
pressed.
(Disabled) Follow-You is not enabled on the device. Follow-
You is unavailable to user on this device; may be
available on other device(s).

Note: Secure printing must be enabled on the print queue. See Enabling Secure Printing.

9. (optional) From the Enable guest user list, select the option to use for unrestricted access to the
device:
Option Description
Default Uses the configured global setting.
Disabled Overrides the global setting, and denies access.
Enabled Overrides the global setting, and allows access
to guest users.
10.Click OK to save the settings.
Configuring the Launcher
To configure the Launcher container, do the following:
1. Navigate to Configuration > Workflows and Scanning > Workflow containers.

345
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Click Launcher to open the Workflow container definition dialog.

3. Select Follow-You Printing or Release all to include in the Added workflows and containers box.
•
Add a function by selecting it in theAvailable workflows and containers box clicking the
button.
• Remove a function by selecting it in the Added workflows and containers box and clicking the

button.
•
Click the and buttons to arrange the order in which the function buttons display on the
device panel.
4. Define which function is default by selecting or clearing the Default check box.
Selecting a function as Default makes it the highlighted option when the workflows are shown on the
device screen.

346
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. ClickOK.

Enabling the Guest user

The Guest user in Equitrac Embedded for Samsung XOA-Web v1.0 offers the ability to use the
embedded solution for unauthenticated access. Users who are not associated with your enterprise
can gain access to configured features of Equitrac Embedded for Samsung XOA-Web v1.0 without
providing login credentials, or if mobile users want to access the system without authenticating. Guest
workflows can be configured in the same way regular workflows are, allowing for many configurable
options. Using a Release key is one possible way the Guest user feature is used; it can also be used
to provide access to any workflow configured in the Guest user workflow container configured on the
server, such as Guest access to Native functions. The system considers the Guest user as a regular
user, so Function Access Control rules can be configured on the server for the Guest user in order to
control the exact permissions granted to Guest users. The server tracks usage in Reports based on the
Guest user’s identity.
For example, a workflow can be configured to place a "Guest" button on the device login screen which
invokes a Follow-You feature. The user can then release documents with a provided key. Depending
upon configuration, such a workflow may behave in the following manner:

Figure 44: Guest user workflow in Equitrac Embedded for Samsung XOA-Web v1.0

Guest user setup

Before setting up a guest user option, you must configure how you want the function to behave in
Equitrac Express. The workflow that you assign to the guest user function is configured in the same
way as any workflow. Bear in mind what you want the button to do, and create a workflow to match that

347
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

functionality. For instructions on creating workflows, see the Equitrac Office/Express Administration
Guide.
1. In System Manager, navigate to Configuration > Devices > Embedded devices. The Embedded
devices dialog opens:
2. To allow override of the global device settings (and at device-embedded level) thereby allowing
or disallowing Equitrac Embedded for Samsung XOA-Web v1.0-equipped device guest user
functionality regardless of the default setting, choose from the following list under Enable guest
user:
• Default uses the default settings for Guest users as configured above.
• Enabled activates Guest user functionality for this device regardless of the default setting.
• Disabled deactivates Guest user functionality for this device regardless of the default setting.
3. Configure the Guest button. You must configure which text appears on the Guest button, as well
as the workflow associated with the button. You must also configure which user account is used for
guest transactions:
a) In System Manager, navigate to Configuration > Security and authentication > Guest user.
The Guest user dialog opens:

b) In the Button title field, enter the text you want to appear on the button to guide users.
c) In the Workflow container field, enter the container name associated with the button the Guest
user presses to gain access. For information about configuring workflows and containers, see the
Equitrac Office/Express Administration Guide.
Note: You can configure the Guest workflow container to your requirements. The workflow
can contain only Guest-included workflows or standard workflows as well. The container must,
however, use Global scope.
d) Click Verify to ensure the Workflow Container provided is valid.
A dialog box displays, indicating a pass or fail.
e) In the Guest user account field, enter the account leveraged when the Guest user button
processes transactions.
For information about configuring Users, see the Equitrac Office/Express Administration Guide.
f) Click Verify to ensure the Guest user account provided is valid.
A dialog box displays, indicating a pass or fail.
g) Click OK.

Configuring Workflows
Scan-related, system-managed, and device-managed workflow types can be configured in System
Manager. Workflows can be configured to be accessible to all users, or only available to users assigned
to specific departments.

348
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

System-managed and device-manged workflows are configurable, and can be used to create icons to
be added to workflow containers allowing quick access to the specific functions at the device.
To create a workflow, do the following:
1. In System Manager, navigate to Configuration > Workflows and scanning > Workflow
management.

When the Workflow management dialog box first opens, a list of preconfigured workflows is
displayed. Any of these can be edited to suit the required needs of the organization. Additionally,
system-managed and device-managed workflows can be created.
2. In the Workflow management dialog box, click <Add...> (or select an existing workflow from the list)
to open the Workflow definition.

3. Enter a Name for the workflow which users can select as a destination option at the device.
4. Click the Active check box to enable the workflows to be available to use.

349
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. From the Scope list, select either Departmental or Global.

Global workflows are accessible to all users, while Departmental workflows are available to users
assigned to a specific department.
Note: Departmental workflows must be Active in order to apply them at the department level.
Inactive workflows are listed in the Department properties, but cannot be applied.

6. From the Destination list, select the workflow type.

7. (If available) Define the scan destination attributes by clicking the ellipsis button (...) beside the
corresponding attribute’s default value in the Define attribute <Attribute> default value dialog box
and click OK.
8. Click the Image preferences button to set the scan workflow resolution and type.
9. Click the Output file size button to define the scan file size settings.
10.Click the Output formats button to select the scan output formats that will be available to users at
the scanners.
These formats are produced out of the device proper, as opposed to those set up through the SPE.
See the Equitrac Administration Guide for more details on SPE settings.
11.Click OK to save the workflow.
12.Click OK again when the all the desired workflows have been configured.
Note: If only one workflow is configured and available in the Launcher (or equivalent) container
upon user login, Equitrac Embedded for Samsung XOA-Web v1.0 automatically starts that
workflow. If the workflow is in a secondary container, autostart does not apply.
For more information, see the Equitrac Office/Express Administration Guide.

Tracking Jobs Originating at the Device

To correctly track jobs that are printed from the device, enable print tracking through the embedded
device.
1. Select the embedded device from the Devices list.
2. Click on the link beside Tracked activities to open the Embedded device configuration dialog box.

3. Ensure that Copy is selected, then click OK.

Note: Only copy and scan tracking is supported in this release.

4. Click OK again to close the Embedded devices dialog box.

Configuring Card Self-Registration

If you want users to self-register their swipe cards, you must enable this option in System Manager.
When a user swipes an unregistered card, they are required to login to the device with valid primary

350
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

and secondary user credentials. The information the user must enter depends upon the authentication
mechanisms set in System Manager.
1. Open System Manager and navigate to Configuration > Security and authentication > User
authentication.

2. Select Card swipe only or Card swipe or keypad entry from the Input type list.
3. Select Always or Only with keyboard login from the Secondary prompt list..
The If PIN2 available and If PIN2 available or keyboard login options are not supported in Equitrac
Embedded for Samsung XOA-Web v1.0.
Note: If a user has a secondary PIN or external password associated with their user account, they
must enter their secondary user credentials on the device front panel when prompted. If the user
does not have a secondary PIN or password associated with their user account, they can leave the
field blank to proceed.
4. Select the Auto-register primary PINs check box.
Optionally, you can select Register as alternate PIN to record the PIN as the alternate PIN instead
of the primary PIN. The Auto-register primary PINs option must be selected for card registration.

For this option Do this

Equitrac Office/Express PINs Leave selected.

351
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

For this option Do this

External user ID and password Select to verify all user information such as Windows or LDAP
information.
Equitrac PIN with external Enable if users swipe their cards for identification, and must also
password enter their domain user account password. Equitrac Express
cross-checks the database for the corresponding Equitrac
account name, then verify the credentials against the selected
external authority to log the user onto the network network.
5. Select one or more Authentication mechanisms.
6. Click OK to save the changes.
The next time the user swipes the card, their account information is automatically associated with the
card, and they can login without manually entering their user credentials.

Enabling Secure Printing

Secure printing holds documents in a secure print queue until the user releases the document from
Equitrac Embedded for Samsung XOA-Web v1.0.

Configuring the Print Queue

1. Open System Manager and select Devices from the left pane.
2. Click on the print queue you want to configure.
You may have to expand the Physical device and Port to see the print queue.

3. In the Print queue summary dialog, set the Secure Printing option to Enabled from the Behavior
section, and click OK to save the changes.

Enabling Secure Printing on the Embedded Device

When an Embedded device is created automatically, its SDR functions are disabled by default. In order
to use SDR, these functions must be enabled.
1. Open System Manager and select Devices from the left pane.

352
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Click on the embedded device you want to configure. The option Enable secure document release
is enabled automatically.
3. Click OK to save the changes.

Configuring Follow-You Printing

Follow-You Printing extends the basic functionality of secure printing by allowing a user to release
a print job to other compatible devices in the organization. Even if you have deployed multiple DRE
print servers — each of which manages a separate set of devices — you can configure Equitrac Office/
Express to allow printing across multiple print servers.
For example, a user can submit a print job from their computer, and while on the way to a meeting in a
different section of the office, they can walk up to any device (with the embedded application installed on
it) and pull the job to a compatible printer nearest them.
I-Queue solves printing challenges by providing a single print queue for every user and every printer.
When submitting a print job you can setup and use the following printing mode options:
• The I-Queue printer for secure printing via a single Follow-You Printing queue where all printers are
combined into a single pull group. The I-Queue holds print jobs sent to the I-Queue printer from a
user workstation. This I-Queue method only supports secure printing and holds print jobs until the
user releases them at a networked printer via Follow-You Printing.
• Direct printing via the I-Queue direct printer that enables you to print directly to a printer (without
printer driver installation and authentication or a Follow-You-Printing queue at a printer) in a simple
and straightforward method.
• Both of the above methods.
To deploy Equitrac Embedded for Samsung XOA-Web v1.0 in a single-server or a multi-server Follow-
You Printing environment, do the following:
1. Enable secure printing on each device.

353
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Secure printing sets up a virtual print queue that holds jobs until they are released at the embedded
device by a valid user.
2. Create and manage I-Queue (go to System Manager > Devices, right-click the Devices pane and
select Add I-Queue from the menu and define the settings in the I-Queue summary window).
Note: See the Creating an I-Queue chapter in the Equitrac Office/Equitrac Express Administration
Guide for more details.

3. Configure the Follow-You print settings.

Determine the site where you want Follow-You Printing to be accessible from, and choose whether
the print job is priced based on its properties before or after it is released.
Note: See the Advanced Printing Configuration chapter in the Equitrac Office/Equitrac Express
Installation Guide for details on configuring secure printing, Follow-You Printing.

Enabling Release Keys

Release key is an Equitrac Express feature that lets users assign a key value to their documents when
they submit print requests. Users can also assign a release key to a print job allowing other users to
walk up to any embedded device, and print any jobs in the queue that were submitted using that release
key. The job is tracked and charged to the user releasing the job, not the user who assigned the release
key. When prompted for a release key at an embedded device, users are required to enter the same
alpha-numeric key value used at print time to release a job from the secure print queue. To enable
release key prompts on the embedded device, do the following:
1. Open System Manager and navigate to Configuration > User interaction > Session flow.
2. Select Prompt for release key in the Other prompts section if release keys are to be enabled.
3. Click OK to save the setting.

Using Equitrac Embedded for Samsung XOA-Web v1.0

This section describes how to login to Equitrac Embedded for Samsung XOA-Web v1.0 and use its
screens and features on the device. This section also provides information about entering Billing Codes
and using Follow-You Printing.

Elements of Equitrac Embedded for Samsung XOA-Web v1.0 User Interface

The Equitrac Embedded for Samsung XOA-Web v1.0 user interface is touch-based. Use your fingers
to make selections, type on the soft keyboard, scroll lists of options, swipe the screen to reveal more
options, and perform certain system commands.
The Equitrac Embedded for Samsung XOA-Web v1.0 user interface is presented in the main window:

354
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 45: User interface in Equitrac Embedded for Samsung XOA-Web v1.0

This area is controlled by Equitrac Embedded for Samsung XOA-Web v1.0 and is the main interface.
User selection and workflow activity is handled through interaction with this area of the user interface.
Depending upon the currently active Equitrac Embedded for Samsung XOA-Web v1.0 screen, you can
see:
• The current workflow or screen.
• Available workflows as are determined by the administrator at time of setup and by the privileges of
the user currently logged in.

Logging Into Equitrac Embedded for Samsung XOA-Web v1.0

A “Welcome” screen is the first screen of the user interface.

355
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

You can login to Equitrac Embedded for Samsung XOA-Web v1.0 by:
• Providing your authentication credentials (the user is required to enter the associated login
credentials).
• Using your auto card registration (the user is required to login with valid network ID and password.
Once the card is registered, the user is able to log in as normal without being prompted for their login
credentials).
• Using your third-party authentication for Single Sign-On (SSO) feature with Equitrac (the user is
required to login with valid user ID, domain/user ID and password).
• Swiping your card to authenticate a valid user (the user is required to swipe the card at the card
reader attached to the embedded device).
Tap the screen anywhere in the main window of the application. The login screen appears:

356
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

On this screen, users must provide valid user ID authentication credentials before they can access the
device functions available to them. By swiping from the left side of the screen you can invoke Login As
Guest option. For more information, see Enabling Guest User.

Users can opt to select the desired option and then authenticate, so when they login, they are taken
directly to the workflow they selected. Otherwise, users are presented with the Nuance Launcher,
containing their selection of workflows, governed by how workflows are configured in Equitrac Office/
Express, after they login.

357
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

The login process follows this general path:

1. (Optional) Select the desired Quick Selection option from the list on the screen, if available.
2. Enter valid login credentials using the on-screen keyboard (invoked by tapping within the User ID
field), or by using a swipe card.
Depending on configuration, one or two login fields may appear. The following are examples of valid
login credentials:
• Equitrac primary PIN only
• Equitrac primary and secondary PINs
• Windows Networking credentials (network user name and password)
• Swipe card at the card reader
• Swipe card and Equitrac secondary PIN
• Swipe card and Windows password
• Auto card registration
• Equitrac primary PIN and Windows password.
Note: The last prompt field on the Login screen is masked to protect your login credentials. If
secondary prompts are not enabled on the server, the User ID field is masked (***). If secondary
prompts are enabled, the Password field is masked instead.
3. Touch the Login button. The Launcher screen or selected Quick Selection workflow opens.

If you have difficulty logging in

If your credentials are not validated, an error message appears requiring you to try your login again.
If the system does not recognize the swipe card you used to authenticate, you are prompted to enter
your authentication details if the card auto-registration feature is enabled. The next time you swipe the
card, your login information is populated automatically. Otherwise, the system displays a "login failed"
error message.

Launcher
The Equitrac Embedded for Samsung XOA-Web v1.0 Launcher screen is a container that controls
the initial screen after authentication. You must configure the Launcher screen to properly display the
options available on the device.
You can select functions by touching the desired button on the Launcher screen. The following functions
are available: Equitrac Embedded for Samsung XOA-Web v1.0 functions such as Follow-You Printing,
Release All and Native device functions (Copy, Fax, Scan). Optionally, you can also create Workflow
Container.
To offer a specific selection of workflows, the workflows are placed into a container, the contents of
which are shown to the user. For example, the typical Launcher screen for Equitrac Embedded for
Samsung XOA-Web v1.0 is a container that houses the Follow-You Printing, Quick Copy and Release
all workflows.

358
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Using Release Key

Release Key lets users assign an alphanumeric key value to their document when they submit a print
request. When the user needs to identify their document in the secure print queue, they can look for
their document by the release key number. This way, Release Key prevents walk-up users from printing
or deleting other users’ documents.
Release Key appears:
• After Release All is selected: Here, the user can specify a release key to release document(s)
associated with that alphanumeric key.
• After an unknown user combines a release key with the PrinterOn application for mobile printing:
Here, this unknown user is able to bypass logon prompts and log on as a predetermined user (a
release key pop-up menu appears and the user can see and release the associated print jobs).
• After Follow-You Printing is selected (if configured in System Manager to prompt for a release key
on the device): Here, the user can enter the release key code and click OK to continue.
Note: The Follow-You Printing screen will list only documents associated with the release key
specified by the user.

359
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Release Key is an Equitrac Express feature and does not apply to Equitrac Office users.

Using Release All

When Release All is selected, all documents in Follow-You Printing queues are released.
Note: When the user presses Release All icon on Launcher screen and the Workflow features
indicate prompt for billing code for the Release All workflow, the user is prompted for billing code
before releasing all jobs. The released jobs are charged to the entered billing code.

Using Billing Codes

If billing codes are configured, the Billing Details screen opens before a user accomplishes a task.

360
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: If an account is configured with only one available billing code to charge against, and billing
codes are required, then that code is automatically selected and the Billing Details screen does not
appear.

1. In the Billing Code field enter the billing code.

If you do not know the code, select the Search button, represented by a magnifying glass icon.
An on-screen keyboard displays, allowing you to enter search criteria. Enter the search criteria in
the field, then select Search again, or simply select Search. The keyboard can be dismissed to
select from the resulting list of billing codes. The list contains the first 100 codes that matched your
search. Use swipe gestures to browse through billing codes and select the correct code, which then
populates the Billing Code field.

361
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. If configured, select whether the job is Billable or not by tapping the check box.
This option determines if the transaction is billed to a user, group, or department, or if it is only
entered into the system for reporting purposes.
3. Select Done to continue.
If the Billing Code validation is enabled, the billing code is validated when you select Done. If you
searched for a code and selected it from the list, it is validated immediately. Billing code validation is
set in System Manager > Configuration > Session Flow > Validate Billing Codes.
Note: If the billing code you entered is invalid, try performing a search and selecting the code from
a list instead.

Using Follow-You Printing

The Follow-You Printing screen displays all the queued documents associated with your login
credentials, or release key. By default, the list displays documents in order from longest-queued to most-
recently queued.
Each time you release a document from the Job list, Equitrac Embedded for Samsung XOA-Web v1.0
checks your estimated available account balance. If account limits are enforced, and the total cost of the
selected documents exceed the available account balance, an error message displays indicating that
the estimated account balance would be exceeded and the items will not be printed. The current pages,
documents, costs associated and other information appear in real time for the print jobs selected in the
document details window.

362
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Available operations on the Follow-You Printing screen are:

• Select - or + to adjust the number of copies.
•
Select the icon to force color jobs to print in black & white .
• The top line of the documents list indicates the number of documents available. To select or deselect
all documents, press the check box next to Print Jobs.
• Select or deselect individual print jobs by pressing the print job's respective selection circle.
• Delete individual print jobs by swiping to the left on any print job's row to reveal a trash can icon.
Then, press the icon.
• Select Print to release all selected documents.
The following options are available by selecting the menu icon at the top right of the screen:

• Select Delete to remove all selected documents from the Job List without printing them

363
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

• Select Print&Save to print and save all selected documents from the Job List
• Select Refresh to refresh the current page
• Select About to display the current version of Equitrac Embedded for Samsung XOA-Web v1.0
• Select Logout to log out from Equitrac Embedded for Samsung XOA-Web v1.0

Using Native Copy, Fax and Scan

A variety of native copy, fax and scan workflows can be configured in System Manager. For more
information, see Configuring Workflows.
In Launcher, chose one of the Native device functions. Here, you can access Native Scan, Native Copy
and Native Fax functions within embedded screen.

Logging Out of Equitrac Embedded for Samsung XOA-Web v1.0

To end a user session and log out of Equitrac Embedded for Samsung XOA-Web v1.0, press the
Logout icon from the home screen.

Settings Reference
This section describes options for the Equitrac Embedded for Samsung XOA-Web v1.0 objects and
documents return codes.

Applications Properties
These properties appear in the Device Registration Service Details pane of Applications when you
add or edit a Equitrac Embedded for Samsung XOA-Web v1.0 application. You cannot change the
application type for an existing application.

364
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description

Name A name that uniquely identifies an application.

DWS Service URI The address for Equitrac DWS server login page.
Note: This address can be also used for
multiple devices

For more information on how to move a device

to another DWS, see Moving from One DWS to
Another.

DRS Service URI The address to the DRS server:

http://serverAddress:port/
DeviceManagementRestService/

The default port number for this DRS service is

8755.
Note: The address in this field must be an
IP address.

DCE Server Address The IP address of DCE Server.

Note: DCE and DWS servers must have the
same IP address.

Moving from One DWS to Another

When moving a device from one DWS to another, make sure to update the Application property to
point to another DWS (in case other devices are added to the same DWS). The association of a
device to DWS is defined in the Application profile. In case you want to change it from one DWS server
to another, you must first perform the Deregister Device from Equitrac Only action on all devices
connecting to the old DWS1, before it is changed to DWS2. This way, DRS is unable to recall the old
record pointing to DWS1.Make sure that the device is manually deleted from System Manager when
deleting the device from a DWS. In the case where DWS1 is down at the time when a delete is initiated,
the device is still added to DWS1 when the server comes back up (make sure to delete the device from
DWS1 after that).

Devices Properties
These parameters define the device settings. Click the Edit button to edit the parameters for a device.
Click the Save button to save changes to the parameters or click the Cancel button to discard changes.

Option Description

Name (required) The name of the Samsung device or device

group.

365
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Address (required) The IP address of a Samsung device.
Note: This is a device only parameter
and will not be displayed when configuring
parameters for a device group.

Username The administrator account name for the Samsung

device. The default is "admin".
Note: Username is not required to perform
a selected action on the device.

Password The administrator account password for the

Samsung device. This field is empty by default.

Application (required) A DRS application with Equitrac Embedded for

Samsung XOA-Web v1.0 as its Application Type.
When a device is in a group, this property setting
is always inherited by the group and does not
appear for a device.

Device Group Click a group name in this box to change group

membership. When a device is a member
of a group in can optionally inherit device
settings defined for the group. This allows you
to simultaneously manage settings for multiple
devices. Select the [Devices] option in this list to
remove a device from group membership and
move it to the root folder in the Devices pane.
This option is not visible while you are configuring
options for a new device.

Device use SSL Specifies whether the device is configured to use

SSL to communicate with the server.
• True when the device is configured to use SSL
(HTTPS).
• False when the device is configured to not use
SSL (HTTP).
Tip: If you are uncertain which value to
choose, navigate to the administrative
web page of the device and check the
protocol (http: or https:) displayed on
the address bar of the web browser.

Client Package (required) Select from list of uploaded packages.

• XOA-Web.1.0.zip

366
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Enable USB Printing Choose True to enable printing from the USB port
on the device.
Tip: Regarding USB printing, it is
recommended that users turn off USB
printing by choosing False as USB printing
is not tracked.

Files List
Download the installation package in ZIP format from the Equitrac Partner Portal .
Upload all of these files to Device Registration Service to create the group shown in the table.

Group File name Description

Client Packages XOA-Web.1.0.zip Application package for

installation on devices.

You can upload package files one at a time using the Upload button on the Files tab in Device
Registration Service web client. Alternatively, you can copy files to the following Device Registration
Service plug-in folder:
C:\Program Files (x86)\Nuance\Device Registration Service\Service\Plugins
\NSi.DeviceManagement.Plugins.Samsung.XoaWeb
To upload files for a single group, make sure that you upload all of the files listed for the group. After you
upload files, you can view the files by selecting Equitrac Embedded for Samsung XOA-Web v1.0 in the
Device Type box on the Files tab. A named group can be selected for the Application Package option
in the device settings. This settings determines the files that are installed on the device that is pointed to
by the device Address option.

Actions Reference
To perform an action, first select a device on the Devices tab in the Device Registration Service web
console. To perform an action on all devices in a group, first select the group folder on the Device tab.
Then, in the box at the top of the Details pane, select one of the following actions from the list box and
click the run button .

Action Description

Install Application on Device Only Performs the Uninstall Application from Device
Only Action, and then completes the following
steps:
• Uploads the RPAR to the device.
• The device retrieves the corresponding IPAR
from DRS using the specified DRS service
URI.

367
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Action Description
Install and Register Removes the client application from the device
if it is already installed. Then installs the client
application associated with the DRS Device on the
device.
Reregisters the client application from the DWS if
it is already registered. Then registers the client
application with the DWS.

Uninstall Application from Device Only Removes the client application from the device.

Uninstall and Deregister Removes the client application from the device
and deregisters it from the DWS.

Register Device with Equitrac Only This Action first deregisters the client application
with the DWS if it is already registered. Then it
registers the client application specified by the
Device profile with the DWS.

Deregister Device from Equitrac Only Deregisters the client application from the DWS.

Process Client Package Processes client package associated with a

Device profile to generate the IPAR and RPAR.
Although these steps are performed automatically
upon saving a device record, you can use this
Action to force the files to be regenerated. We also
advise that you perform this action when another
Action fails and returns the following message:
Failed to process client package.

Related tasks
How to perform Device Actions on page 21

Device Notes
In case you want to perform maintenance or actions to the device or software, this section provides
some general notes.

Finalize the Uninstallation

Uninstallation of Equitrac Embedded for Samsung XOA-Web v1.0 is handled through DRS. For more
information, see the uninstallation instructions in the Device Registration Service User Guide for
instructions.

Rebooting the device

A reboot of the device is recommended after install or uninstalling new software. Follow these steps:

368
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. Locate the physical on/off switch of the device, then press until the device screen displays a dialog
indicating the device is shutting down.
You can then release the button. The shutdown process may take as long as 7 minutes.
2. Once the device is fully shut down, press the on/off button again.
The screen indicates the startup is in progress.
Depending upon the device’s setup, the main display will either show the Equitrac Embedded for
Samsung XOA-Web v1.0 login screen, or if the embedded solution is not installed, the standard
Launcher screen with option icons.

369
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Smart UX Unified

Client for Samsung

Overview of the Nuance Unified Client for Samsung Smart UX

The Nuance Unified Client for Samsung Smart UX provides copy control, scanning, and secure printing
implemented on the Smart UX SDK. Embedded on the MFP, Nuance Unified Client for Samsung
Smart UX controls access to the MFP, and acts as the gateway for Nuance functionality. Users must
authenticate to gain access to Nuance-controlled device functions.
Use Device Registration Service (DRS) to deploy the embedded client on devices and configure it to
either or both capture and print on a client. Capture (with process and route) functionality is supported
by Nuance AutoStore, while print management may be supported by Nuance Equitrac.
If using Equitrac only or combined Equitrac and Autostore deployments, users must authenticate to
gain access to Nuance-controlled device functions. Nuance Unified Client for Samsung Smart UX
communicates with Nuance servers and tracks user activity. During a user session, device activity is
captured by the Equitrac server.
The Nuance Unified Client for Samsung Smart UX provides device authentication with a single
application for Equitrac Follow-You Printing and scanning into AutoStore workflows. This client secures
access to devices, allows the user to toggle between Follow-You Printing and scanning, provides card
reader support, searchable billing codes at device login, and job accounting.
The Nuance Unified Client for Samsung Smart UX supports AutoStore and Equitrac authentication
through user name and password, card identification (ID) with an optional personal identification number
(PIN), and card swipe with an optional PIN.
The following operation modes are provided:
• When Equitrac is installed, it controls access to the MFP and when the user walks up to the device
they see a login screen
• When Equitrac is not installed, AutoStore only provides the scanning functionality and when the user
walks up to the device, they have to start the Nuance application to gain access to Scan functionality
Note: The Nuance application may prompt for identification before showing the workflows, if
configured.

370
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Checklist: Nuance Unified Client for Samsung Smart UX

implementation
This checklist should evolve based on the experience you gain from performing deployments. You might
also want to perform custom checks that are based on a specific aspect of your network architecture or
environment.

Table 10: Samsung Smart UX Deployment Checklist

Check Description See

Confirm that your system meets • Requirements on page 372

requirements.

Confirm that you have all of the • Additional documentation for

relevant documentation for the Equitrac on page 376
reference.

For AutoStore capture • Samsung SmartUX

functionality, configure the component help in AutoStore
Samsung SmartUX in an Process Designer.
AutoStore workflow using the
AutoStore Process Designer.

To use Equitrac as the Print • Server Side Configuration on

Manager, or to enable scanning page 378
using Equitrac, configure the
Samsung Smart UX embedded
type on the Equitrac server.
Note: If you are deploying
a large fleet of devices, we
recommend that you apply
the typical embedded
licenses for the devices
before installing the
embedded application.
Otherwise, the software
can be licensed after the
application is installed on
the device. See Licensing
Nuance Unified Client for
Samsung Smart UX on
page 378

371
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description See

Download the Nuance Unified • See Files tab on page 415

Client for Samsung Smart UX
installation package from the
Equitrac Partner Portal and add
it to the DRS server.

Add a DRS application for • Add an application

Nuance Unified Client for • Application properties on
Samsung Smart UX. page 410

Add or import a Nuance Unified • Add a device

Client for Samsung Smart UX • Import a device
Device in DRS. • Nuance Unified Client for
Note: Ensure you have Samsung Smart UX device
administrator credentials properties on page 412
to access all MFPs where
the client is deployed.

Install and configure Nuance • Nuance Unified Client for

Unified Client for Samsung Samsung Smart UX actions
Smart UX. reference on page 415

Requirements
Component Requirement
AutoStore Version 7.0 SP4 or later

Equitrac Equitrac Office or Equitrac Express version 5.7

with all available hotfixes installed, or later

DRS Version 7.10 or later

Card readers The Nuance Unified Client for Samsung Smart UX
supports Equitrac USB external card readers and
Samsung-supported third-party card readers.

Supported devices • Nuance Supported Device Search: Samsung

372
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Configuring Nuance Unified Client for Samsung Smart UX

This section documents how to configure AutoStore and Equitrac to use with the Nuance Unified Client
for Samsung Smart UX.
Important: Specific Samsung Smart UX device settings vary by geographic location and setup.
Please consult your Samsung technician for any MFP-specific settings needed for your particular
deployment.

Configure AutoStore
Add the Samsung SmartUX component to an AutoStore workflow to provide capture functionality
for Samsung Smart UX devices with the Nuance Unified Client for Samsung Smart UX. When you
configure the client on a device, you need to specify the AutoStore server address as well as the port
number specified on the on the Preferences tab of the AutoStore component configuration.When you
create the DRS application, specify the AutoStore server address as well as the port number specified
on the Preferences tab of the AutoStore component configuration.
For details about configuring the Samsung SmartUX component in AutoStore, refer to the component
help in AutoStore Process Designer.

AutoStore Features for Nuance Unified Client for Samsung Smart UX

Nuance Unified Client for Samsung Smart UX supports the following AutoStore features:
• AutoStore Capture and Send capability
• Allow different set of forms to be used with groups of devices.
• Support for Tree, List, Text, Checkbox, Numeric, Date, Label, Button and Lookup List field types for
flexible forms.
• Simplified creation of forms for sending scanned documents to an email address, a folder
destination, or a SharePoint repository.
• Easy sharing of forms with the use of the save/load form from template functions.
• Forms are extensible through VB.NET and C#. You can create more interactive forms and validate
before a document is scanned. Integrated editor with IntelliSense makes the creation of scripts
easier.
• Windows authentication at the MFP panel.
• Custom authentication allows you to configure other authentication methods.
• Allow only certain users to have access to a form.

AutoStore server-side configuration

The Nuance Unified Client for Samsung Smart UX can be configured to communicate with an AutoStore
server only, with an Equitrac server only, or simultaneously with both an AutoStore and an Equitrac
server.
An AutoStore server is supported by specifying the server and port number configured for the Samsung
SmartUX component in an AutoStore workflow. AutoStore forms control capture of documents by a user
working on an MFP. Additional AutoStore components in a workflow provide processing and routing of
captured documents.

Additional documentation for AutoStore

You may need to refer to one of the following documents when performing server-side configuration
tasks.

373
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Guide When to refer to this guide Where to find the guide

AutoStore Help This provides help for building Locate this help on the Help
AutoStore workflows and menu in the AutoStore Process
reference information for Designer.
AutoStore components including
the Samsung SmartUX
component.

Nuance AutoStore This is a PDF version of the Locate this file for download by
Administration Guide AutoStore help. logging into the Nuance Web
License Tool and selecting the
AutoStore 7 for product.

Nuance AutoStore Installation Use this guide to perform an Locate this file for download by
Guide initial installation or upgrade of logging into the Nuance Web
AutoStore. License Tool and selecting the
AutoStore 7 for product.

Device Registration Service Use this online help guide to The DRS help is found by
(DRS) User Guide determine basic use cases and clicking on the Help button within
User-related setups. the DRS application.

Device Registration Service Use this help guide to determine Locate this file on the Equitrac
Installation Guide installation, uninstallation and Partner Portal.
upgrade processes.

AutoStore Smart UX component licensing

AutoStore product and component licensing is performed in AutoStore Process Designer using the
License Manager application.
The procedure for licensing AutoStore components is described in the Nuance AutoStore Installation
Guide.
Related concepts
Additional documentation for AutoStore on page 373

Configure Equitrac
Configure the authentication for the Nuance Unified Client for Samsung Smart UX component to work
with Equitrac authentication.
The Nuance Unified Client for Samsung Smart UX provides copy control, scanning, and secure printing
on specific Samsung Smart UX manufactured multi-functional printers (MFPs). Embedded on the MFP,
Nuance Unified Client for Samsung Smart UX controls access to the MFP, and acts as the gateway for
Nuance functionality. Users must authenticate to gain access to Nuance-controlled device functions.

Equitrac Features for Nuance Unified Client for Samsung Smart UX

Nuance Unified Client for Samsung Smart UX supports the following Equitrac features:

Authentication Requires users to enter valid authentication

information to unlock the MFP functions. Users
can enter their authentication data via the MFP

374
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

panel, or by using a valid authentication card

(when authentication cards are implemented).
Follow-You Printing® After successful login at the MFP, the user can
access the virtual print queue to "pull" a print job
to this device. Through the Follow-You screen on
the MFP, users can see a list of documents in the
queue, then select, delete, or release documents
for printing. See Enabling Secure Printing for
configuration instructions, and Using Follow-You
Printing or end-user instructions.
Scan-to-Me® Allows users to scan a document and email it
to their own address, and optionally to other
addresses via the CC field (if enabled). Users
can specify scan options (for example: duplex,
color, size) and document format prior to initiating
a scan. See Configuring Capture and Send for
configuration instructions, and Scanning for end-
user instructions.
Equitrac Capture and Send capability Allows Samsung Smart UX to use third-party
applications to scan to multiple scan destinations
through the Scan Processing Engine (SPE).
Currently, Samsung Smart UX allows SharePoint
(Teamsite) to scan to a web-based location, and
RightFax to scan directly to a Fax number.
Card self-registration Allows users to associate an unassigned card with
their user credentials. Once associated, each time
the user swipes the card, the system automatically
recognizes the card and associated user. See
Configuring Card Self-Registration or instructions.
Billing Code support (Equitrac only) Users can change their jobs to a particular code,
and the Equitrac Office/Express database tracks
the characteristics of jobs changed to the code.
Billing codes must be enabled on the Equitrac
server. See Enabling the Billing Code Prompt and
also refer to the Creating & Managing Accounts
chapter in the Equitrac Office or Equitrac Express
Administration Guide.
Campus card support When enabled on the Equitrac Express server,
campus card payment systems including
Blackboard UNIX, Blackboard Windows, and
CBord Retail Transaction Interface. At the MFP,
users can authorize themselves as valid campus
card account holders, make copies, release
jobs, and pay for these services in real time,
directly from their campus card account. See the
Managing Devices chapter in the Equitrac Express
Administration Guide.
Offline operation (Equitrac only) In the event that Samsung Smart UX fails to
connect to the Equitrac DCE service, you can
configure Samsung Smart UX to continue the MFP

375
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

lock down, allowing users to authenticate based

on account information stored in local MFP cache.
Samsung Smart UX gathers job data in local
cache, and forwards the accounting details to the
DCE service when it is back online. See Offline
Operation Through DCE Caching for configuration
instructions.
Integration with third party applications Samsung Smart UX tracks job details generated
(Equitrac only) from supported third party applications. Currently,
the third-party applications supported for scan are
SharePoint and RightFax.
Support for multiple DCE servers (Equitrac In Equitrac, you can designate up to four different
only) DCE servers — one primary, and up to three
backup servers. We recommend that the primary
DCE is located on-site to allow for the fastest
possible data transfer. Other DCE servers can be
located off-site.

Installation and Configuration

This section describes how to install Nuance Unified Client for Samsung Smart UX on supported
multifunction printers (MFPs) and configure the product for initial start-up. In addition to this guide,
ensure that you have any necessary documentation for Equitrac and AutoStore and any documentation
for your MFP.
Note: This guide assumes that you are installing the Nuance products (servers and embedded
applications) in a Windows network environment. This guide does not provide any information for
third-party software (including databases) or operating system support.
Prerequisites: Before You Install
Please see Checklist: Nuance Unified Client for Samsung Smart UX implementation on page 371 for
all prerequisites.
Equitrac server-side configuration
The Nuance Unified Client for Samsung Smart UX can be configured to communicate with an Equitrac
server only, with an AutoStore server only, or simultaneously with both an Equitrac and an AutoStore
server.
Print manager address and port number settings for the in Nuance Unified Client for Samsung Smart
UX provide information that the client requires to communicate with the Equitrac server. DCE server
address settings specify primary and additional device control engines for Equitrac. Configuration on the
server define Equitrac functionality available to users.
Additional documentation for Equitrac
You may need to refer to one of the following documents when performing server-side configuration
tasks.

376
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Guide When to refer to this guide Where to find the guide

Equitrac Office and Express Before installing Equitrac Installed automatically with
Planning Guide Office or Express, use this Equitrac in the Program
guide to select the appropriate Files\Equitrac\Express
combination of product variables \Documentation folder.
to support the needs of your
institution or organization.

Equitrac Office and Express Use this guide to perform an Installed automatically with
Installation Guide initial installation or upgrade. Equitrac in the Program
Files\Equitrac\Express
\Documentation folder.

Equitrac Office and Express After installing Equitrac Office Installed automatically with
Administration Guide or Express, use this guide to Equitrac in the Program
configure advanced options for Files\Equitrac\Express
use on your campus or in your \Documentation folder.
organization.

Device Registration Service Use this online help guide to The DRS help is found by
(DRS) User Guide determine basic use cases and clicking on the Help button within
user-related setups. the DRS application.

Device Registration Service Use this help guide to determine Locate this file on the Equitrac
Installation Guide installation, uninstallation and Partner Portal.
upgrade processes.

Equitrac Card Readers

Equitrac USB card readers are typically automatically detected by the device upon start-up. There is
no MFP or server configuration required for Nuance Unified Client for Samsung Smart UX to recognize
card reader hardware. Some card readers can be configured to detect multiple card types. If your card
reader supports more than one type of card, we recommend configuring it for only the type of card used.
Note: Card reads within authentication work flows must be configured on the server in System
Manager. Otherwise, card reads are not recognized. For detailed information about configuring
authentication work flows, see the Equitrac Office or Equitrac Express Administration Guide.
Card reader setup
Samsung Smart UX devices have more than one available USB port. Equitrac card readers can occupy
the USB port located to the left side of the Samsung Smart UX Panel, and can also leverage the internal
mini USB connector port.
Note: Third-Party card readers which are supported by the Samsung Smart UX device may also be
used. Such readers may require a separate Nuance license. Additional MFP setup and configuration
is required for Samsung-supported 3rd party card readers.
USB Keyboards
Samsung Smart UX devices do not support the use of USB keyboards. The on-screen software
keyboard is used instead.

377
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Server Side Configuration

Licensing Nuance Unified Client for Samsung Smart UX
Each Nuance Unified Client for Samsung Smart UX installation requires a license applied in the Equitrac
System Manager. You must obtain one license per device, or purchase a license pack that contains
enough licenses for all of the devices you want to enable for use. You can buy single licenses or license
packs as needed.
If you intend to use Equitrac to scan to external destinations, a separate Capture and Send license
is also required. Third-party or other native scan applications do not require separate licenses from
Equitrac.
Once you obtain the licenses, you need to activate them in the Equitrac System Manager. By default,
System Manager resides on the machine that hosts the accounting server. However, System Manager
may be installed on any machine on the network that has a connection to the CAS.
1. Open System Manager by selecting Start > All Programs > Equitrac Office/Express > System
Manager.
2. In the Select Accounting server dialog box, choose the CAS with which Equitrac System Manager
is associated, then click Connect. If the server is not listed, enter the host name or IP address in the
server field.
3. When System Manager opens, click Licensing in the left menu pane.
4. Under Current tasks, click Add license, or click <Add...> in the right pane.
5. When the Equitrac activation window opens, click Next to begin the activation process.
6. Enter the serial number for each components you want to activate. These serial numbers were
supplied with your software. After you enter each complete serial number, click Add to add it to the
list, then enter additional serial numbers as required.

7. When all numbers are entered, click Next.

8. Select Automatic online activation or Manual activation, and click Next.

378
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: If you do not have a connection to both the Internet and CAS, choose Manual activation.

9. For Manual activation, do the following:

a) Contact Nuance Customer Support at https://nuanceimaging.custhelp.com/app/imaging/contact/
or by telephone to obtain the corresponding activation codes.
b) After receiving the required activation codes, click Finish to continue.
c) In the Add licensing Information dialog box, enter the Activation code, and click Add.
d) The activated software license appears in System Manager.
10.For Automatic online activation, do the following:
a) In the Embedded device licensing screen, select Samsung from the Manufacturer list, then click
Next.
b) Follow the Activation wizard prompts to provide contact information. If you have already
registered one or more Equitrac components, the Activation wizard fills the form with previously-
collected data.
c) The Activation wizard displays a Collecting information... message while retrieving system data.
If you want to omit technical details about your system, click the Show technical details button
and select the information you do not want to transmit. You must transmit the following:
• Accounting server serial number
• Domain-qualified print server name
• Organization name as registered in Windows
• Fully-qualified server DNS name
d) When the Activation wizard is ready to transmit the information, review the collected data. Choose
whether to send optional data with your activation request.
Note: The Activation wizard transmits the data using an HTTP connection to the Equitrac
activation server. If the connection fails, the Activation wizard prompts for verification that
you have configured the default gateway correctly, and that the Internet is accessible from
this machine. You can retry or cancel the activation request at this point. If you cancel, the
Activation wizard prompts you to use manual activation instead
e) Once the Activation wizard sends the activation data and Equitrac returns the activation code, the
Wizard automatically records the license activation in System Manager, and displays a summary
of the activation results:
• Activation code
• Description
• Serial number
• Status (Success; Invalid- the serial number is invalid, or Denied- the serial number was valid
but not accepted)
If the License is Invalid
If the status is Invalid, ensure that you entered all serial numbers and activation codes precisely. Each
component requires a separate license—unless you purchased a suite license. If the problem persists,
contact the Equitrac Customer Support Center to resolve this problem.
If the Serial Number is Denied
If the status is Denied, the serial number may already be registered to a different system ID. Contact the
Equitrac Customer Support Center to resolve this problem. Switch to the Assignment View in System
Manager, to see the number of licenses purchased and the number of licenses used.

379
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Add a Printer on a TCP/IP Printer Port

Nuance Unified Client for Samsung Smart UX makes use of standard Windows TCP/IP printer ports.
When setting up your device, note the following:
• Use the standard Add Printer function included in the Windows OS.
• Use only TCP/IP Ports. Do not use Web Services for Devices (WSD) ports as they are not
supported.
• If the device is part of a group of devices available to print from a designated queue (pull group), it
must use a driver compatible with all other devices in the pull group.

Server-Side Configuration
After you complete the install and configuration of Nuance Unified Client for Samsung Smart UX on the
MFP, you need to register and configure it on the Equitrac Office or Equitrac Express Core Accounting
Server (CAS). The server-side settings determine how the software operates on the MFP.

Configuring Nuance Unified Client for Samsung Smart UX Embedded Devices

Each embedded device entry in System Manager must be associated with a physical device (MFP).
Once Nuance Unified Client for Samsung Smart UX is installed, your device communicates with the
Device Control Engine (DCE) specified during the installation and configuration via the DRS component,
an embedded device entry is automatically created in the Equitrac Office or Equitrac Express system,
only if you applied the software license before installing the software on the MFP.
There are two methods of registering Nuance Unified Client for Samsung Smart UX MFPs as devices in
System Manager:
• Through automatic creation (the default method)
• By manual registration and configuration

Automatically Creating Embedded Devices

Equitrac Office or Equitrac Express automatically creates the Samsung Smart UX devices if you have
applied the licenses first, and have already configured the device with the location of the DCE.
When you connect an MFP that hosts Nuance Unified Client for Samsung Smart UX to the network and
turn it on, the application automatically looks for the DCE. The DCE can provide a license confirmation
to the device, as well as pass the device information to System Manager. After a successful connection
and licensing approval, the embedded application appears in the System Manager > Devices listing.

Note: You can rename the auto-created entries as needed using terms and descriptions appropriate
for your organization by right-clicking on an entry and selecting Edit from the menu.

Manually Configuring Embedded Devices

Use the System Manager > Devices link to manually add an embedded device that is associated with
®
a single physical device. This includes enabling Follow-You Printing and release behaviors, as well as
copy, scan and fax access on each MFP.

380
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Before installing and registering each MFP as an Equitrac Office/Express device, ensure that you have
activated the appropriate license for the device on the Equitrac Core Accounting Server (CAS).
The following procedure assumes you have already registered the physical device hosting Samsung
Smart UX within System Manager. For details on performing this procedure, see the Equitrac Office or
Equitrac Express Administration Guide.
To register each device with CAS, perform the following procedure on an Equitrac Office/Express
administrative workstation:
1. Open System Manager and select the Devices link. The right pane displays the devices registered
in System Manager.
2. Right-click on the device and select Add embedded device to open the Embedded device dialog
box.

3. Select Samsung Smart UX in the Type drop-down list.

4. Enter a Name and Description for the embedded device.
5. Specify the Server hosting the DCE associated with this physical and embedded device.
6. Enter the Serial number for the device. This must match the serial number as shown on the MFP
itself.
7. Leave the HID decoding setting at Default.
For information about this setting, see the Equitrac Office/ Express Administration Guide.
8. Click Pricing to configure pricing at the embedded device level.
You can create a price list then assign it as the default price list for all of the device functions, or set
a price list for each separate function. For details on configuring price lists, see the Equitrac Office or
Equitrac Express Administration Guide.
Note: The default price list is used if a new price list is not designated for the device.

9. Click the link beside Tracked activities to override default tracking options for a particular embedded
device.
For more information, see Configuring Workflows.
10.If you have defined Rule sets in System Manager, select one from the drop-down list to apply to this
embedded device. For more information on creating rule sets, see the Equitrac Office or Equitrac
Express Administration Guide.
11.In the Release behavior box, select one of the following options to specify documents released at
login.
Option Description
First is released: Released Releases only the first document in the user’s
queue.

381
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Prompt Prompts the user to release all or select
documents for that user.
Release all at login Releases all queued documents for the current
user automatically after successful login.

®
Note: Follow-You Printing must be enabled on the print queue. See Enabling Secure Printing.

12.From the Disclaimer drop-down list, select the disclaimer you want to use at the close of an email.
For information about setting up disclaimers, see the Equitrac Office/Express Administration Guide.
13.From the Enable guest user drop-down list, select the option to use for unauthenticated access to
the device:
Option Description
Default Uses the configured global setting.
Disabled Overrides the global setting, and denies access.
Enabled Overrides the global setting, and allows access
to guest users.
14.Click OK to save the settings.

Licensing the device

Scan workflows, except those using Scan-to-Me, require an Equitrac Capture and Send license. You
must obtain a license per device to enable these options.
To assign a Capture and Send license, do the following:
1. Open System Manager, and select Licensing in the left pane.
2. Select the Assignment View tab to open the list of all assigned licenses.
3. Expand or right-click the Capture and Send license option, and select Add to open the Assign
license dialog box.

382
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. On the Assign license dialog box, select the check box for the devices to assign the Capture and
Send license to.
At the bottom of the dialog box is a counter displaying the number of available licenses and available
devices. These numbers decrease with every license assigned.
5. Click OK after the licenses have been assigned to the desired devices.
The devices assigned for Capture and Send now display under the Capture and Send license
option. To remove an assigned license from a device, right-click the device and select Remove
assignment. The number of used licenses are adjusted accordingly.

Enabling the Guest user

The Guest user in the Samsung Smart UX offers the ability to use the embedded solution for
unauthenticated access. Users who are not associated with your enterprise can gain access to
configured features of Samsung Smart UX without providing log in credentials, or if mobile users want to
access the system without authenticating. Guest workflows can be configured in the same way regular
workflows are, allowing for many configurable options. Using a Release key is one possible way the
Guest user feature is used; it can also be used to provide access to any workflow configured in the
Guest user workflow container configured on the server, such as Guest access to Native functions. The
system considers the Guest user as a regular user, so Function Access Control rules can be configured
on the server for the Guest user in order to control the exact permissions granted to Guest users.
The server tracks usage in Reports based on the Guest user’s identity. The Guest users identity is
determined by the Guest user configuration in System Manager.

Sample Guest User Configuration

For example, a workflow can be configured to place a <GUEST> button on the device log in screen
which invokes a Follow-You feature. The user can then release documents with a provided key.
Depending upon configuration, such a workflow may behave in the following manner:

383
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Guest user setup

Before setting up a Guest user option, you must configure how you want the function to behave
in Equitrac Office or Equitrac Express. The workflow that you assign to the Guest User function is
configured in the same way as any workflow. Bear in mind what you want the button to do, and create
a workflow to match that functionality. For instructions on creating workflows, see the Equitrac Office or
Equitrac Express Administration Guide.
1. In System Manager, navigate to Configuration > Devices > Embedded devices.
This opens the Embedded devices dialog box.

2. Ensure the Enable guest user check box is selected.

384
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

This enables all the Samsung Smart UX-equipped devices to allow Guest User functionality
by default. You can then designate which devices allow Guest User functionality per device, if
necessary.
3. Configure the Guest button. You must configure which text appears on the Guest button, as well
as the workflow associated with the button. You must also configure which user account is used for
guest transactions:
a) In System Manager, navigate to Configuration > Security and authentication > Guest user.
This opens the Guest user dialog box:

b) In the Button title field, enter the text you want to appear on the button to guide users.
c) In the Workflow container field, enter the container name associated with the button the Guest
user presses to gain access.
For information about configuring workflows and containers, see the Equitrac Office or Equitrac
Express Administration Guide.
Note: You can configure the Guest Workflow container to your requirements. The container
can contain only Guest-included workflows or standard workflows as well. The container must,
however, use Global scope.
d) Click Verify to ensure the Container provided is valid.
This displays a prompt indicating a pass or fail.
e) In the Guest user account field, enter the account leveraged when the Guest user function
processes transactions.
For information about configuring Users, see the Equitrac Office or Equitrac Express
Administration Guide.
f) Click Verify to ensure the Guest user account provided is valid.
This displays a prompt dialog box indicating a pass or fail.
g) Click OK.
To allow override of the global device settings, thereby allowing or disallowing a device using the
Samsung Smart UX the Guest User functionality regardless of the default setting, do the following:
4. In System Manger, navigate to Devices, and in the right pane, double click the embedded device you
want to configure.
This opens the device’s Embedded device dialog box.
5. Select the desired Guest user functionality in the Enable guest user list:
Option Description
Default Uses the default settings for Guest users as
configured above.

385
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Enabled Activates Guest user functionality for this device
regardless of the default setting.
Disabled Deactivates Guest user functionality for this
device regardless of the default setting.

Configuring Workflows
An Equitrac workflow is a use case or sequence of interactions for a user at an MFP. Each workflow
can be started by a user by selecting an icon on the MFP console after authentication. These icons are
analogous to AutoStore forms on an MFP console.
A variety of scan, print, and native workflows (fax, scan, and copy) can be configured in System
Manager. Workflows can be configured to be accessible to all users, or only available to users assigned
to specific departments.
Common scan workflows can be configured for email, network folders, RightFax and SharePoint
destinations. Workflows are configurable, and can be used to create icons to be added to workflow
containers allowing quick access to the specific functions at the device.
As an example you can create a scan workflow as follows:
1. In System Manager, navigate to Configuration > Workflows and scanning > Workflow
management.
When the Workflow management dialog box first opens, a list of preconfigured workflows is
displayed. Any of these can be edited to suit the scanning needs of the organization. Additionally,
custom scan-related, system-managed and device-managed workflows can be created.

2. In the Workflow management dialog box, click <Add...> (or select an existing workflow from the list)
to open the Workflow definition dialog box.

386
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Enter a descriptive Name for the workflow which users can identify and select at the MFP.
Note: If the length of the chosen name exceeds the available space on the display, the name is
truncated to fill the available space.

4. Click the Active check box to enable the workflows to be available to use.
5. From the Scope drop-down list, select either Departmental or Global. Global workflows are
accessible to all users, while Departmental workflows are available to users assigned to a specific
department.
Note: Departmental workflows must be Active in order to apply them at the department level.
Inactive workflows are listed in the Department properties, but cannot be applied.

6. From the Destination drop-down list, select the workflow type.

7. Define the scan destination attributes by clicking the ellipsis button (...) beside the corresponding
attribute’s default value in the Define attribute attribute-name default value dialog box and click
OK.
8. Click the Image preferences button to set the scan workflow resolution and type.
9. Click the Output file size button to define the scan file size settings.
10.Click the Output formats button to select the scan output formats that will be available to users
at the scanners. These formats are produced out of the device proper, as opposed to those set up
through the SPE. See the Equitrac Administration Guide for more details on SPE settings.
11.Click OK to save the workflow.
12.Click OK again when the all the desired workflows have been configured.
Note: Multiple workflows can be grouped in a container (which can themselves be nested in
child containers). If only one workflow is configured and available in the Launcher (or equivalent)
container upon user login, the Samsung Smart UX automatically starts that workflow. If the
workflow is in a 'child' container, autostart does not apply.
For more information, see the Equitrac Office or Equitrac Express Administration Guide.

387
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Tracking Jobs Originating at the Device

To correctly track jobs that printed from the MFP, enable print tracking through the embedded device.
1. Select the embedded device from the Devices list.
2. Click on the link beside Tracked activities to open the Embedded device configuration dialog box.

3. Select either Copy or Scan for the activities you want to track.
4. Click OK again to close the Embedded devices dialog box.

Setting timeouts on a Samsung Smart UX device

Timeout settings control specify intervals for reverting to a previous screen or logging out a user when
there is no activity on a Samsung Smart UX device.
• How to configure the System Timeout on page 388
The System Timeout is the interval when there is no activity after which the Samsung Smart UX
reverts to the previous screen.
• How to set the Auto Logout Timer on page 388
The Auto Logout Timer automatically logs out a user account after a specified interval when a user
leaves a Samsung Smart UX device unattended.
How to configure the System Timeout
The System Timeout is the interval when there is no activity after which the Samsung Smart UX reverts
to the previous screen.
For example, if the System Timeout is set to 60 seconds, and a user does not press any options on the
Copy screen for 60 seconds, the Samsung Smart UX device will revert to the Samsung Home screen.
1. On a workstation, open a web browser, and navigate to the network IP address of the MFP.
This opens the SyncThru Web Service pages, which show device information and settings.
2. On the menu bar, click Settings > Machine settings.
3. In the Settings pane, expand Machine Settings > System and click Setup.
4. In the Setup pane, next to System Timeout, select the Enable check box, if necessary, and enter a
timeout value between 10 and 600 seconds.
5. Click the Apply button to save the new setting.
How to set the Auto Logout Timer
The Auto Logout Timer automatically logs out a user account after a specified interval when a user
leaves a Samsung Smart UX device unattended.
1. On a workstation, open a web browser, and navigate to the network IP address of the MFP.
This opens the SyncThru Web Service pages, which show device information and settings.
2. On the menu bar, click Security > User Access Control.
3. In the Security pane, expand User Access Control and click Authentication.
4. In the Authentication pane, in the Authentication Method settings, select the Local Authentication
option.
5. Click the Options button.

388
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

6. In the Options dialog box, click the Logout Policy tab.

7. Next to Auto logout, select Enable.
8. Next to Seconds [15-1720], enter the interval in seconds that a user will be logged out after
inactivity.
9. Click the Apply button, and when prompted that your selections were modified successfully, click
OK.
10.Click the Close button.
11.In the Authentication Method settings, switch the Authentication Method back to Nuance Unified
Client for Samsung Smart UX.
12.Click the Apply button to save the change.

Configuring Card Self-Registration

If you want users to self-register their swipe cards, you must enable this option in System Manager.
When a user swipes an unregistered card, they are required to log in to the MFP with valid primary
and secondary user credentials. The information the user must enter depends upon the authentication
mechanisms set in System Manager.
1. Open System Manager and navigate to Configuration > Security and authentication > User
authentication.

389
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Select one or more Authentication mechanisms:

• Equitrac Office or Equitrac Express PINs – Leave selected.
• External user ID and password – Select to verify all user information such as Windows or LDAP
information.
• Equitrac PIN with external password – Enable if users swipe their cards for identification, and
must also enter their domain user account password. Equitrac Office or Equitrac Express cross-
checks the database for the corresponding Equitrac account name, then verify the credentials
against the selected external authority for network log on.
3. Select Card swipe only or Card swipe or keypad entry from the Input type drop-down list.
4. Select Always or Only with keyboard login from the Secondary prompt drop-down list. The If
PIN2 available and If PIN2 available or keyboard login options are not supported in Nuance
Unified Client for Samsung Smart UX.
Note: If a user has a secondary PIN or external password associated with their user account, they
must enter their secondary user credentials on the MFP front panel when prompted. If the user

390
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

does not have a secondary PIN or password associated with their user account, they can leave the
field blank to proceed.
5. Select the Auto-register primary PINs check box. Optionally, you can select Register as alternate
PIN to record the PIN as the alternate PIN instead of the primary PIN. The Auto-register primary
PINs option must be selected for card registration.
6. Click OK to save the changes.
The next time the user swipes the card, their account information is automatically associated with the
card, and they can log in without manually entering their user credentials.

Enabling Secure Printing

Secure printing holds documents in a secure print queue until the user releases the document from
Nuance Unified Client for Samsung Smart UX.
Secure Printing on the Physical Device
1. Open System Manager and select Devices from the left pane.
2. Click on the print queue you want to configure. You may have to expand the Physical device and Port
to see the print queue.

3. In the Print queue summary dialog box, set the Secure Printing option to Enabled from the
Behavior section, and click OK to save the changes.

Enabling Secure Printing on the Embedded Device

®
When an Embedded device is created automatically, its Follow-You Printing functions are disabled by
®
default. In order to use Follow-You Printing , these functions must be enabled.
1. Open System Manager and select Devices from the left pane.
2. Click on the embedded device you want to configure.
3. Check the option Enable secure document release, then click OK to save the changes.
Note: The option may be unavailable. You must still click OK to effect server changes and enable
®
Follow-You Printing .

391
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

®
Configuring Follow-You Printing
®
Follow-You Printing extends the basic functionality of secure printing by allowing a user to release
a print job to other compatible devices in the organization. Even if you deployed multiple DRE print
servers—each of which manages a separate set of devices—you can configure Equitrac Office or
Equitrac Express to allow printing across multiple print servers.
For example, a user can submit a print job from their computer, and while on the way to a meeting in a
different section of the office, they can walk up to any MFP (with the embedded application installed on
it) and pull the job to a compatible printer nearest them.
Note: The native Samsung Print Application for a device must be disabled for Follow-You Printing to
work.

If you want to deploy Nuance Unified Client for Samsung Smart UX in a single-server or a multi-server
®
Follow-You Printing environment, do the following:
1. Enable secure printing on each MFP.
Secure printing sets up a virtual print queue that holds jobs until they are released at the embedded
device by a valid user.
2. Create and manage pull groups.
To allow users to release print jobs through Nuance Unified Client for Samsung Smart UX, you must
create Pull groups, then add each physical device hosting the embedded application to a pull group.
3. Configure the Follow-You print settings.
®
Determine the site where you want Follow-You Printing to be accessible from, and choose whether
the print job is priced based on its properties before or after it is released.
4. Optional: You can enable multi-server Follow-You to make this a global setting instead configuring it
for each device.
Note: See the Advanced Printing Configuration chapter in the Equitrac Office or Equitrac Express
®
Installation Guide for details on configuring Follow-You Printing and device Pull groups.

Configuring Capture and Send

Equitrac Office and Express include a simple scan workflow named Scan-To-Me. Equitrac also has a
licensable set of features named Capture and Send.
The Capture and Send feature enables the Samsung Smart UX to scan documents to a network folder
on the web via SharePoint, a telephone fax number via RightFax, network folders on your local area

392
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

network, and email through your server. You require a Capture and Send license per device to enable
the functions. In the case of SharePoint and RightFax, there must be as many SharePoint or RightFax
destinations as there are SharePoint or RightFax servers (one destination per server). For example,
if each department has a SharePoint server, each one must be added as a valid Scan Destination. In
the case of network folders and email addresses, you can set up scan aliases. For information on scan
aliases, see the Equitrac Office or Equitrac Express Administration Guide.
Note: To use scan features offered through Equitrac Capture and Send, you must install the Scan
Processing Engine (SPE) component of Equitrac Office or Equitrac Express. See the Equitrac Office
or Equitrac Express Administration Guide for information about SPE.

To configure their use:

1. Open System Manager and select Configuration > Workflows and scanning > Scan
destinations.
This opens Scan destinations dialog box.
2. Click <Add...> to add an application.

3. Once added, configure the scan destination by clicking it, then enter values for the scan destination
fields in the Scan destination definition dialog box if they do not already contain the correct
information.
Note: Not all server settings are applicable to all devices.

For detailed instructions on configuring scan destinations see the Equitrac Office or Equitrac Express
Administration Guide.
Scan-to-Me
Scan-to-Me allows users to scan documents and email the results to a preset email address. The email
address used is pulled from the user’s account information in the Equitrac Account Manager. Note that
users with no email addresses enabled do not see a Scan-to-Me option. If you want to allow users with
a valid email address to use the Scan-to-Me feature in Nuance Unified Client for Samsung Smart UX,
ensure that it is enabled in System Manager.
Note: The Scan Processing Engine (SPE) component of Equitrac Office or Equitrac Express is
required.

1. Open System Manager, and navigate to Configuration > Workflows and scanning > Scan-to-Me.
2. In the Scan-to-Me dialog box, select the Enable check box. Selecting this option places the Scan-to-
Me button on the Samsung Smart UX log in screen, and allows users to access the feature.
Note: You must also ensure the Scan-To-Me feature is in the Launcher Container.

393
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Availability of these global settings will vary depending on the capabilities of a particular
device.

3. Under Settings, enable the following options if necessary:

Option Description

Enable advanced settings When enabled, adds a manual configuration

menu to the system, including Scan settings,
Auto density, Feed type, and Filename/type to
the Scan-to-Me screen on the MFP. Users can
click on the menu items to change scan settings.

Duplexing Sets the default duplex option. Sets the default

duplex option. Choose either Duplex or Simplex.

Scan type Sets the default color option. Choose either

Color scan or Monochrome scan.

Enable To field When enabled, the To field on the Scan-to-Me

screen on the MFP is editable, allowing users to
enter one or more email addresses.

394
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description

Exclude logged in user email address When enabled, the user can remove their email
address from the To field, and not receive the
scan in their mailbox. If the To field is empty,
then the user’s email address is automatically
put back into the To field.

Enable CC field When enabled, adds the Cc field to the Scan-to-

Me screen on the MFP, allowing users to enter
one or more email addresses. The scan is sent
to users in the Cc list, as well as to the user who
performed the scan.

Note: The Scan-to-Me option is not available to users without an email account associated with
their Equitrac account.

Note: Email functionality is handled exclusively through the server associated with the client, not
at the device.

4. In the Default group box, set the default Subject and File name attributes for the files resulting from
Scan-to-Me operations:
a) Click the ellipsis (. . .) of the attribute you want to change.
This opens the Define attribute dialog box.
b) Alter the existing default setting for the attribute by selecting a new one from the drop-down list, or
clicking on the text and replacing it.
Configure the Mail Server
To configure the mail server:
1. Open System Manager and navigate to Configuration > Network environment > SMTP mail
server, then click Add.

2. Enter your SMTP Email server which is either the server’s DNS name or IP Address.

395
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Select Enable TLS and enter a Mail from address for system generated messages. This address
appears in the From field when a user receives a notification email message.
4. Select Basic Authentication if your SMTP mail server requires a user name and password each
time a message is generated.
5. Click OK to save the changes.
Note: General scan through SMTP information is centralized on the server.

Enforcing Color Quotas

Nuance Unified Client for Samsung Smart UX can enforce limits on the number of color prints and
copies that any user can make, based on their user account quota limits. If configured to do so, the
software can disable the MFP when a user exceeds their color limit. For a more detailed discussion
about Color Quotas, see the Equitrac Office or Equitrac Express Administration Guide.
To enable the software to enforce color print and copy quota limits, do the following:
1. Open System Manager and navigate to Configuration > Accounting and quotas > Color quota.
2. In the Color quota dialog box, select the Enable color quota check box.

3. Select the Disable copying on color devices once quota exceeded check box. This disallows
black and white copying, and stops color copies if users exceed their color quota limits.
Note: Copy color quotas are not yet supported.

4. Enter a Custom message to display to the user when they have exceeded their color quota.
5. Click OK to save any changes.
Enabling the Billing Code Prompt
If billing codes are enabled on the Equitrac Server, you can determine when the billing code prompt
appears to the user on the MFP. There are two options—after user identification, and at job release.
1. Open System Manager, and navigate to Configuration > User interaction > Session flow.

396
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. Select one or both billing code prompts.

Option Description
Prompt for billing code after user Typically used in workflows where only copy and
identification (at copiers) scan are used. The billing code screen appears
right after the user logs in, and before they can
access any copier function (including copy, fax,
scan, and job release).
Prompt for billing code at job release (at Used to set billing code behavior on legacy
copiers) devices, this causes the billing code screen
to appear after the user logs in, and again
when they release one or more print jobs on
the Follow-You screen. In the Samsung Smart
UX, this setting is ignored. To set up similar
prompting for billing code at job release in the
Samsung Smart UX, do so within the Workflow.
See Configuring Workflows in the Equitrac Office
or Equitrac Express Administration Guide.
3. Click OK to save any changes.
You can override these server-side billing code prompts on a per device basis. Go to System Manager
> Devicesand select the embedded device to open its properties dialog box. Select either Default,
Prompt or Do not prompt from the Prompt for billing code drop-down list.

Operation Through DCE Caching

If Nuance Unified Client for Samsung Smart UX cannot communicate with the DCE, the client goes
into "offline" mode. At this point, the device can still authenticate user credentials against its own
internal cache, if enabled. If a connection between DCE and CAS fails, then the device will authenticate
using the DCE server rather than the internal cache. In either case, users whose credentials match a
previously cached set are granted device access; if the credentials do not match, the users are denied
access. In offline mode, the Samsung Smart UX allows the caching of card swipe data through DCE.
To enable Login caching if the DCE loses contact with CAS, do the following:
1. Open System Manager and navigate to Configuration > Security and authentication > User
authentication. The User Authentication configuration dialog box opens.

397
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

2. In the CAS offline behavior section, select the Login caching from the DCE servers drop-down
list.
• Disabled: DCE follows offline behavior settings; the regular rules for cached only and allow all
apply.
• Enabled: DCE authenticates users against its internal cache, rather than contacting CAS.
DCE login caching determines whether a user login is accepted or denied when CAS is offline. If
DCE caching is disabled when CAS is offline, then users cannot login. If DCE caching is enabled
when CAS is offline, then DCE allows users to login only if they had previously logged in when
CAS was online.
For example, if DCE caching is enabled, and User1 authenticated while CAS was online, but
User2 did not, then if CAS goes offline, User1 can still login, but User2 cannot login until CAS
comes online again. Once CAS is back online, then User2 can login, and continue to login even if
CAS goes offline again.
Note: Account limits are not enforced, and Billing Codes are not validated when DCE is
operating without a connection to CAS.

3. Select how DRE servers handle print jobs when CAS is offline.
• Auto select: If account limits are enforced, then the Do not print option is used. If account limits
are not enforced, then the Print, charge accounts later option is used.
• Do not print: Users cannot print, and must wait until CAS is back online in order to print.
• Print, charge accounts later: Users can print, and then the print job is charged to their account
when CAS is back online.

Configuring Account and Session Display

Nuance Unified Client for Samsung Smart UX can display account information during a user session,
and provide a Session summary at the end of a user session.
To select the display options you want to have available, do the following:
1. Open System Manager, and navigate to Configuration > User interaction > Session flow.

2. In the Optional display fields section, select which fields you want displayed during a user session.
The following options are available:

398
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Sub-option
Account name • Display throughout session
• Do not display

Follow-You • At start of session (does not apply to this version of the Samsung Smart UX).
balance • At end of session
• At start and end of session
• Do not display

Session cost • At end of session

• Do not display

CAUTION: The session costs and user account balances displayed at end of a session are
estimates based on average copy costs. The actual values stored on the server may differ from
these values.
Note: In order for the Samsung Smart UX Session Summary screen to appear on the MFP,
Account balance and/or Session cost must be set to display at the end of a user session.

Configuring Available MFP Functions

The functions that are available, how they are displayed, and to which users these functions are
presented, is dependent upon various configuration options. When determining which workflows are
available to the user, consider:
• The licensing applied to the device. Scan workflows, except those using Scan-to-Me, require an
Equitrac Capture and Send license. You must obtain a license per device to enable these options.
• Workflow and Workflow Container Settings for the device. For functions to appear, they must be
correctly set in System Manger using Workflows and Workflow Containers. They can then be ordered
and enabled as required by the administrator. The Launcher and Quick Shortcuts bar containers
govern which items appear on the Launcher screen and Quick Shortcuts bar list. These containers
cannot be removed. Other containers, such as the Scan container are supplied for your convenience,
and can be removed or added as needed. Although containers may have workflow associations,
actual workflows are only available if the related features are configured, licensed and available to
the user based on global and departmental settings (see below). For detailed instructions on how to
use Workflows and Workflow Containers, see the Equitrac Office or Equitrac Express Administration
Guide.
• Global or departmental settings. Within Workflows or Workflow containers, you can set functions
to be accessible by any logged in user (a global setting), or by the logged in user’s specific
department (a department setting, which acts as a subset of valid users to allow more granular
control over which functions a user is able to access).

Elements of Nuance Unified Client for Samsung Smart UX User Interface

You can perform various functions at any time in the user workflow, depending upon settings. The
Nuance Unified Client for Samsung Smart UX user interface is touch-based. Use your finger or a
pointing device such as a stylus to make common touchscreen type gestures, type on the soft keyboard,
scroll lists of options, and perform certain system commands. Users can swipe the screen to reveal
more options, as indicated by the carousel dots. The user interface for the Samsung Smart UX is
presented in three areas:

399
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 46: Typical Nuance Launcher Screen, indicating the three areas

Status bar This area is controlled by the device.

•
You can click the button to display recent
system notifications.
•
You can click the button to display the
currently logged in user name.

App bar This area is controlled by the device, and is used

primarily to access commands. The following
options are possible:
• Name of currently workflow or screen.
•
The Nav icon , which displays a menu of
options relevant to the current application.
• Additional information, such as the current
account balance.

Content area This area is controlled by the Samsung Smart UX,

and is the main interface. Most user selection and
workflow activity is handled through interaction
with this area of the UI. Depending upon the
currently active screen, the following options are
possible:
• Information Bar. Indicates the current workflow
or screen, as well as additional information
such as the current account balance.
• Nuance Navigation Button. When present,
displays a list of options relevant to the current
workflow.
• All available workflows. These are determined
by the administrator at time of setup, and by
the privileges of the user currently logged in.

400
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Workflows that act as gateways to additional

workflow groups are enclosed in square
braces. for example, [Scan] opens a menu
with additional options.

Android toolbar This area is controlled by the underlying operating

system, and is used primarily for navigation.
Depending upon the currently active screen, the
following options are possible:
• Back Arrow. Returns the user either to the
previous screen, the Nuance Launcher, or the
Samsung Smart UX Home screen, depending
upon the system screen displayed.
• Down Arrow. When the soft keyboard is
displayed on the screen, this arrow dismisses
it.
• Android home page. Returns the user to the
Android Home screen of the MFP.
• Running applications button.

The following image shows the alternate Nuance screen and commands on the Nav icon

menu.

Samsung Smart UX Workflow and Workflow Container Settings for the device
For functions to appear, they must be correctly set in System Manger using Workflows and Workflow
Containers. Note the following information about Workflow container settings:
• The Samsung Smart UX requires a default item for the Quick Shortcuts bar. If there is no default
configured on the server, the Samsung Smart UX selects the first item in the list as the default item.
• ®
If Follow-You Printing (also referred to as Secure Document Release or SDR) are not enabled in
the Physical Device settings, configured workflows do not appear. Ensure that you have selected and

401
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

enabled these options. See Enabling Secure Printing . In some cases after having made a change
you need to force a cache update to the DCE for the change to take effect. See Managing DRC in
the Equitrac Office or Equitrac Express Administration Guide for instructions.
• Devices must have an associated Capture and Send license and a configured SPE associated for
scan workflows to appear.
• Any item placed in the Quick shortcuts bar, must also be in the launcher.
• If a workflow container has only one workflow, the Samsung Smart UX will execute that workflow,
and no further selection is necessary.
• Workflow configurations for Follow-You Printing and Release All contain an option to configure billing
code at release. This setting overrides all other prompt for release configurations in the system.
For detailed instructions on how to use Workflows and Workflow Containers, see the Equitrac Office or
Equitrac Express Administration Guide.

Multi-Language Support
The Nuance Unified Client for Samsung Smart UX installation program and configuration features are
available in English only.
Multi-language support for the Nuance Unified Client for Samsung Smart UX interface includes support
for the languages listed below. The language is selected automatically based on the MFP language. If
the MFP language is not available, English is used by default.

• Simplified Chinese • Finnish • Norwegian • Turkish

• Traditional Chinese • French • Polish

• Catalan • German • Portuguese

• Czech • Hungarian • Russian

• Dutch • Italian • Spanish

• Danish • Japanese • Swedish

• English • Korean • Thai

To change the language on a device, you must select the language in two places:
• On the devices SWS page, change the Language setting.
• On the device, change the language specified on My page.
After you make these changes you must reboot the device for the changes to take effect.

402
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Using Nuance Unified Client for Samsung Smart UX

This section documents typical use cases and screen elements of the Nuance Unified Client for
Samsung Smart UX.

Typical User Workflows

This section describes how to login to Nuance Unified Client for Samsung Smart UX and use its screens
and features on the MFP. This section also provides information about entering billing codes and using
campus cards.
Billing Codes – A billing code is a unique combination of characters that represent a charge-back
group. You can assign your transactions to a particular code, and Equitrac Office or Equitrac Express
tracks the characteristics of copy or print jobs assigned to the code.
Color quota – Color quotas are used to limit the amount of color printing that you can produce. As you
print, Nuance Unified Client for Samsung Smart UX compares your output to your color quota balance
(in number of pages). Once you reach the quota, the application disables the color function on the
MFP. If you still have funds remaining in your account, you can switch settings to black and white and
continue to print black & white documents only. You are able to produce color output only when your
color quota is reset on the server.

Logging Into Nuance Unified Client for Samsung Smart UX

After the Samsung Smart UX starts, you can display the Login screen either by tapping anywhere in the
main window, or swiping across the screen in either direction:

On this screen, users must provide valid authentication credentials before they can access the device
functions available to them.
If there are quick shortcut options available through a configured container, they display directly on
both the Welcome and Login screens, as above. Users can opt to select the desired option and then
authenticate, so when they login, they are taken directly to the workflow they selected. Otherwise,
users are presented with the default option the administrator has chosen in the Quick Select Container,

403
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

which contains their selection of workflows, governed by how Workflows and their respective Workflow
Containers are configured in Equitrac Office or Equitrac Express, after they login.
The login process follows this general path:
1. Touch anywhere in the main display window, or use touchscreen type gestures to swipe in either
direction on the screen to display the Login screen.
2. (Optional) Select the desired Quick Selection option from the list on the screen, if available.
3. Enter valid login credentials using the on-screen keyboard (invoked by tapping within the User ID
field), or by presenting your card.
Depending on configuration, one or more login fields may appear. The following are examples of
valid login credentials:
• Equitrac primary PIN only
• Equitrac primary and secondary PINs
• Windows Networking credentials — network user name and password
• Present a card at the card reader
• Present a card and Equitrac secondary PIN
• Present a card and provide Windows password
• Equitrac primary PIN and Windows password
• Campus card swiped at the card reader. (for Equitrac Express only)
Note: The last prompt field on the Login screen is masked to protect your login credentials. If
secondary prompts are not enabled on the server, the User ID field is masked (***). If secondary
prompts are enabled, the second field is masked instead.
4. Touch the Login button.
Completing this task opens the Launcher screen or selected Quick Selection workflow.
If you have difficulty logging in
If your credentials are not validated, an error message appears requiring you to try your login again.
If the system does not recognize the swipe card you used to authenticate, you are prompted to enter
your authentication details if the card auto-registration feature is enabled. The next time you swipe the
card, your login information is populated automatically. Otherwise, the system displays a "login failed"
error.

Entering Billing Codes

If billing codes are configured, the Accounting/Billing Code screen opens before a user accomplishes
a task. The code entered here applies to copy and scan jobs. If overrides for Follow-You printing are
enabled, a billing code which overrides the first can be entered and upon job release in the Follow-You
Printing screen.
Note: If an account is configured with only one available billing code to charge against, and billing
codes are required, then that code is automatically selected and the Billing Code screen does not
appear unless the "Billable" option is enabled.

404
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. In the Billing Code field enter the billing code, if required.

If you don’t know the code, select the Search button, represented by a magnifying glass icon. An
onscreen keyboard displays, allowing you to enter search criteria. The keyboard can be dismissed to
select from the resulting list of billing codes if it covers some of the results. The list initially contains
all billing codes, and then narrows to a subset based on the search criteria entered. The list contains
the first 100 codes that matched your search. Use swipe gestures to browse through billing codes
and select the correct code, which then populates the Billing Code field.
2. If configured, select whether the job is Billable or not by tapping the check box.
This option determines if the transaction is billed to a user, group, or department, or if it is only
entered into the system for reporting purposes.
3. Select Done to continue.
If the Billing Code validation is enabled, the billing code is validated when you select Done. If you
searched for a code and selected it from the list, it is validated immediately. Billing code validation is
set in System Manager > Configuration > Session Flow > Validate Billing Codes.
Note: If the billing code you entered is invalid, try performing a search and selecting the code from
a list instead.

Using Follow-You Printing

The Follow-You Printing screen displays all the queued documents associated with your login
credentials, or release key. By default, the list displays documents in order from longest-queued to most-
recently queued.
Each time you release a document from the Job list, the Samsung Smart UX checks your estimated
available account balance. If account limits are enforced, and the total cost of the selected documents
exceed the available account balance, an error message displays indicating that the account balance
would be exceeded and the items will not be printed. The current pages, documents, costs associated
and other information appears in real time for the print jobs selected in the document details window at
the lower right of the screen.
Note: Account limits are a licensable feature available in Equitrac Office or Equitrac Express.

405
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: To ensure that error messages display during print release, ensure that the escrow setting
is enabled on the Equitrac server. Escrow is enabled in System manager under Configuration >
Accounting and Quotas > Enable Escrow.
Available operations on the Follow-You Printing screen are:
• Select - or + to adjust the number of copies.
•
Select the icon to force color jobs to print in black & white.
• The top line of the documents list indicates the number of documents available. To select or deselect
all documents, press the check box next to Print Jobs.
• Select or deselect individual print jobs by pressing the print job's respective selection check box.
• Delete individual print jobs by swiping to the left on any print job's row to reveal a trash can icon.
Then, press the icon.
• Select Print to release all selected documents.

The following options are available by pressing the Nav icon at the top right of the screen:
• Select Select All to select all documents. To deselect a document and not release it for printing,
press the respective print job's check box.
• Select Print & Save to release any selected print job(s) and save them in the print queue.
• Select Delete to remove all selected documents from the Job List without printing them.
• Select Refresh to update the document list.
The following options are available from the Android toolbar:
•
Press the Home button to return to the MFP's native Android's Home screen.
•
Press the Back button to return to the Nuance Launcher screen.

Scanning
Nuance Unified Client for Samsung Smart UX offers the ability to perform many different scan tasks
using Equitrac or AutoStore. These include scanning to email and network folders, to SharePoint (team
site) repositories,and scanning directly to fax through RightFax. To use these Equitrac options, the
Capture and Send function, which enables the Samsung Smart UX to perform these tasks, must be set

406
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

up and licensed. See Manually Configuring Embedded Devices for information about enabling these
features. You can license Nuance AutoStore components to provide rich forms and many different
scanning, processing, and routing solutions.
Nuance Unified Client for Samsung Smart UX acts as a user-facing experience to handle numerous
scanning solutions. For example, Equitrac Scan-to-Me functions are handled through the Samsung
Smart UX, and users can scan to network folders, email addresses or directly to fax recipients based on
the workflow chosen. The workflow experience for each feature is identical to an end user regardless of
the product used to process the scan. The options available to a user depend upon the administrator's
setup, the user's settings, and which features are licensed.
Detailed information on setting up scan workflows is found in the Equitrac Office or Equitrac Express
Administration Guide. Instructions for creating AutoStore workflows to capture, process, and route
documents can be found in the AutoStore help, available on the Help menu in AutoStore Process
Designer.
Scanning can proceed either by using the Automatic Document Feeder (ADF) on the device, or by
scanning directly from the glass of the MFP one sheet at a time.
Note: If a user wants to quit a scan, this can be done using the Cancel button at any time.

Note: Users can append pages to documents mid-scan job when scanning from the glass.

Terminology
For the purposes of this section, the terms used refer to the following:

Scan Task An operation which delivers a scan to a particular

end point. This can me a destination such as an
email address or network location, or a service
such as a RightFax operation.
Documents One or more pages that will be scanned. There
can be as many pages per document as required,
within the limits of what the device allows.
Scan Job A collection of Documents. You can scan
multiple Documents at a time, which are then
concatenated into a Scan Job.
Job Details A collection of metadata that is applied to a Scan
Job. Typically, any collection of Documents will
share the same Job Details through their inclusion
in a Scan Job.

Prepare to scan
Log in to the Samsung Smart UX at the device with your credentials. Place the document you want to
scan into the Automatic Document Feeder (ADF) or, onto the glass of the scanner.
Note: You can place your document at the start of the workflow, or at any time prior to scanning.

Select a Scan workflow from the available options. Scan workflows are typically set up in Equitrac
System Manager or AutoStore Process Designer to simplify and automate the scan process. The
following is an example Scan-To-Me screen.

407
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Although the Unified Client displays both Equitrac and AutoStore scanning workflows, their
availability depends on licensing each server. If Equitrac Capture and Send is not licensed and
configured, then only Scan-To-Me functions are available for Equitrac.
Note: The Scan Processing Engine (SPE) component of Equitrac Office or Equitrac Office or
Equitrac Express must be installed to enable Equitrac scan functionality. An AutoStore server must be
deployed to enable AutoStore scan, process, and route functionality.
Depending upon the destination of your scan, you may be asked to provide specific meta data. These
Job Details are associated with the Scan Job in question. This information determines specific attributes
used in the routing and type of scan produced. Depending upon how each Scan workflow is configured
on the server, some Job Details are collected automatically based upon your login information.
Information that is collected automatically may be changeable. For example, your email address may be
filled in automatically when sending a scan as a mail destination in the From attribute. However, if the
configuration allows it, you can change this to a different address. In some cases, these attributes are
configured to be static, in which case you cannot override them, and they may not appear altogether.
For this reason, the changeable fields presented to you at the device may differ from Scan Task to Scan
Task, and even from user to user, depending upon configuration. A list of metadata by workflow type
includes:
• Equitrac Scan-To-Me or Equitrac Scan to Email

Field Description
To The email address to route the completed scan.
For this workflow, the To field typically auto-
populated with the email address associated to
the logged-in user.
Cc The email address of any other recipient to
whom the user wants to send the scan.
Subject The subject of the email when delivered.
Typically, this defaults to Scan-To-Me.
Body Any text the user wants to include in the body of
the email message containing the resulting scan.

408
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Field Description
File Name The desired name of the scanned file. This
typically auto-populates with system information.
Delivery Format The desired format for the finished scan. This
selection field allows a user to select whatever
formats are offered through the device setup.
This setting defaults to the format specified by
the user on the MFP.
Press the field and select the desired option.
Note that this list can often be scrolled to display
more options than those which fit on screen.

• Equitrac Scan To Network Folder

Field Description
Network Folder The fully qualified UNC path to the network scan
folder. The resulting scan is deposited into this
location on the network
File Name The desired name of the scanned file. This
typically auto-populates with system information.
Delivery Format The desired format for the finished scan.
Typically, scans are delivered in PDF format,
but this selection field allows a user to select
whatever formats are offered through the device
setup. Press the field and select the desired
option. Note that this list can often be scrolled
to display more options than those which fit on
screen. The default is the format configured in
the MFP settings.

Fields with an asterisk (*) next to them are required. Static fields will allow you to view but not change
their contents. These fields appear for your information only.
If you want to change the Scan settings, such as paper size, dpi, or brightness, press the Change
button. This opens a new dialog box. The options for Scan Settings are governed by the abilities of the
MFP hosting the solution. Depending upon licensing and your configuration, full scan integration with
AutoStore is supported. Make the changes you want, then save and you will be returned to the scan
workflow.

Using LDAP Email Search

LDAP email look-up can be used from the Scan-To-Me screen or any scan to email-enabled feature. In
order to use LDAP search, it must be enabled and configured on the server. See the Equitrac Office or
Equitrac Express Administration Guide for details. If not configured, the search magnifying glass icon
does not appear. To perform a search, use the search magnifying glass icons located beside any To and
Cc fields in workflows that use them.
To perform an email search, do the following:
1. Select the Magnifying glass button beside the To or Cc fields to search for and add addresses to
the corresponding field.

409
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: If there are no search criteria entered, the list below the search box contains the entire
LDAP email directory.

Completing this opens a Search screen:

2. If not already displayed, press the search magnifying glass icon to display the keyboard.
3. Enter your search criteria. The list below reflects email addresses that match the criteria as you type.
4. When you finish entering your search criteria, or the list displays the correct result, dismiss the
keyboard using the down arrow, and then press the appropriate email in the list.
5. Select one or more addresses, and click OK to exit the Email Search feature.
6. Make a selection from the results, and touch OK. The information populates the To or Cc field.

Reference
This section describes options for the Nuance Unified Client for Samsung Smart UX objects and
documents return and status codes.

Application properties
A Device Registration Service application profile for the Nuance Unified Client for Samsung Smart UX
specifies connection information for an AutoStore server and a Print Manager server. This information
allows an MFP or MFD to use capture and print management services on these servers.
These properties appear in the Device Registration Service Details pane when you add or edit a
Nuance Unified Client for Samsung Smart UX application. You cannot change the application type for an
existing application.

Property Description

Name A name that uniquely identifies an application.

410
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
Server configuration The following configuration options are available:
• AutoStore only
• Equitrac
• AutoStore and Equitrac.
The remaining properties shown here appear after
you make this selection. You cannot change the
application type after you save a new application
profile.

AutoStore Server Address Identifies an AutoStore server to be used to

capture documents.
This can be an IP address, a system name (if
the systems are in the same domain), or a fully
qualified domain name. We recommend that you
use an IP address only if it is static.
This option is only available when AutoStore only
or AutoStore and Equitrac is selected.

AutoStore Server Port The port that the AutoStore server uses to
communicate with clients.
This setting must match the port number that is set
on the Preferences tab of the Samsung SmartUX
component settings in AutoStore. The default is
3350.
This option is only available when AutoStore only
or AutoStore and Equitrac is selected.

AutoStore Server use SSL Specifies whether devices should connect to

the server using SSL. This should correspond
to whether Use SSL check box is selected in
the Samsung SmartUX capture component
Preferences settings in the AutoStore workflow
that will be used with the devices.
This option is only available when AutoStore only
or AutoStore and Equitrac is selected.

DCE Server Address The address for the primary device control engine
for Equitrac.
This option is only available when Equitrac only or
AutoStore and Equitrac is selected.

411
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
DCE Server #2 Address The address of a second fail safe device control
engine for Equitrac. This setting is optional.
This option is only available when Equitrac only or
AutoStore and Equitrac is selected.

DCE Server #3 Address The IP address of a third fail safe device control
engine for Equitrac. This setting is optional.
This option is only available when Equitrac only or
AutoStore and Equitrac is selected.

DCE Server #4 Address The IP address of a fourth fail safe device control
engine for Equitrac. This setting is optional.
This option is only available when Equitrac only or
AutoStore and Equitrac is selected.

Nuance Unified Client for Samsung Smart UX device properties

Nuance Unified Client for Samsung Smart UX device properties are configured in the Device
Registration Service web console. When configured for a device group, they can be propagated to any
device in the group.

These parameters define the device settings. Click the edit button to edit the parameters for a
device. Click the save button to save changes to the parameters or click the cancel button to
discard changes.

Option Description

Name The name of the Samsung Smart UX device or

device group.

Address The IP address of a Samsung Smart UX device.

Note: This is a device only parameter
and will not be displayed when configuring
parameters for a device group.

412
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Inherit Properties from Group This option is visible only when a device is located
in a group folder in the Devices pane.
• True specifies to use property settings for the
group. The remaining property settings will be
inherited from the group and unavailable for
configuration here.
• False specifies to configure property settings
separately for this device. The remaining
settings will be available for configuration here
except in their description.

Username The administrator user name for the Samsung

Smart UX device. The default is "admin".
Note: Username is not required to perform
a selected action on the device.

Password The administrator password for the Samsung

Smart UX device. This field is empty by default.

Application A DRS application with Samsung SmartUX as its

Application Type. When a device is in a group,
this property setting is always inherited from the
group and does not appear for a device.

Device Group Click a group name in this box to change group

membership. When a device is a member
of a group in can optionally inherit device
settings defined for the group. This allows you
to simultaneously manage settings for multiple
devices. Select the [Devices] option in this list to
remove a device from group membership and
move it to the root folder in the Devices pane.
This option is not visible while you are configuring
options for a new device.

413
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Device use SSL Specifies whether the device is configured to use
SSL to communicate with the server.
• True when the device is configured to use SSL
(HTTPS).
• False when the device is configured to not use
SSL (HTTP).
Tip: If you are uncertain which value to
choose, navigate to the administrative
web page of the device and check the
protocol (http: or https:) displayed on
the address bar of the web browser.

Client Package Select a client package from this list. The selected
application package is downloaded to a device by
the Install action. List items are populated by the
uploaded files specified on the Files tab. Samsung
Smart UX installation packages are downloaded
from the Equitrac Partner Portal or from the Web
Licensing Portal. for information about how to
add a Samsung Smart UX installation package to
DRS.

Service Package Select a service package from this list. The

selected application package is downloaded
to a device by the Install action. List items are
populated by the uploaded files specified on
the Files tab. Samsung Smart UX installation
packages are downloaded from the Equitrac
Partner Portal or from the Web Licensing Portal.
for information about how to add a Samsung
Smart UX installation package to DRS.

Samsung Smart UX Device Registration Device Status

When a device is selected on the Device tab on the Device Registration Service client web page,
the Status bar in the Details pane displays the current device status for the Samsung Smart UX
application. Click the refresh button on the Status bar to display the current status for a device. The
message shows Device not reachable if the IP address is not valid or the device is currently not
visible on the network.

414
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Unified Client App status Service status DRS status message

Valid Valid Client : Status -

Version : 1.0.0.537;
Service : Status -
Version : 1.6.0

Valid Error Client : Status -

Version : 1.0.0.537;
Service : Error message

Error - Error message

Files tab
The Files tab in the Device Registration Service web client lists available Samsung Smart UX installation
packages for devices. A package in this list may be specified in the DRS device configuration for a
Samsung Smart UX device.
Download the installation files from the Equitrac Partner Portal or from the Web Licensing Portal. Extract
and upload all of these files to Device Registration Service.

Group Contents Description

SmartUXServicesXXXXX.zip SmartUXServices.apk Package metadata files for
SamsungSmartUX-prod.apk version number XXXXX (such as
SmartUXServices160br2.zip).

Extract and upload files one at a time using the Upload button on the Files tab in Device Registration
Service web client. Alternatively, you can manually copy files to the following Device Registration
Service plugin folder:
C:\Program Files (x86)\Nuance\Device Registration Service\Service\Plugins
\NSi.DeviceManagement.Plugins.SamsungSmartUX
Before you upload files for a single group, select Samsung Smart UX in a Device Type dropdown list on
the Files tab. Make sure that you upload all of the files listed for the group.
To view these files, select Samsung Smart UX in a Device Type dropdown list on the Files tab. A
named group can be selected for the Application Package option in the device settings. This settings
determines the files that are installed on the MFP that is pointed to by the device Address option.
Related concepts
Working with client packages on page 18
Related tasks
How to upload a Unified Client installation package to DRS on page 20
This procedure describes how to upload Unified Client installation packages downloaded from a Nuance
download portal. An installation package is specified in the Unified Client Device settings.

Nuance Unified Client for Samsung Smart UX actions reference

Actions that can be performed from the Device Registration Service for a Nuance Unified Client for
Samsung Smart UX device. An action can be performed on a single device or on all devices in a group.
To perform an action, first select a device on the Device tab in the Device Registration Service web
console. Then, in the box at the top of the Details pane, click an available action to perform on the

415
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

device and click the run button . To perform an action on all devices in a group, first select the group
folder on the Device tab, and then run the action.

Action Description

Install Installs the Nuance Unified Client for Samsung

Smart UX on the device.

Uninstall Uninstalls the Nuance Unified Client for Samsung

Smart UX on the device.

Configure Updates device configuration for the Nuance

Unified Client for Samsung Smart UX package
installed on the device. This action must be run
after you complete the Install action.

Nuance Unified Client for Samsung Smart UX return codes

Nuance Unified Client for Samsung Smart UX return codes appear for device actions that you perform
through Device Registration Service.
The following return codes may appear for Nuance Unified Client for Samsung Smart UX history items
in the Action History panel in the Device Registration Service Web Client.

Return Code Description

0 Configuration successfully completed.

1 Configuration successfully completed with

message:
Warning: Some configurations not set

100 Client package is installed.

500 General error

501 Application not installed on device

502 Authentication failed

503 Device unreachable

Action Status Codes

The codes in this topic may be displayed after completing an action.
The following action status codes are available:
• Valid statuses: Enabled / Disabled / Unknown
• Errors: Not found / Unreachable / Authentication failure / Invalid certificate

416
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Unified Client App status Service status DRS status message

Valid Valid Client : Status -

Version : 1.0.0.537;
Service : Status -
Version : 1.6.0

Valid Error Client : Status -

Version : 1.0.0.537;
Service : Error message

Error - Error message

Quick Start
For users who have experience setting up the Samsung Smart UX solution, the following process acts
as an overview of the fundamental steps required to install Samsung Smart UX in:
• An AutoStore only environment
• An Equitrac only environment
• AutoStore and Equitrac environment.

Quick Setup Process for AutoStore

Follow these steps to perform an installation of Samsung Smart UX for an AutoStore only environment:
Note: All steps outlined are performed from the server where the installation takes place.
Administrative access to the server is required.

1. Install Device Registration Service (DRS).

a) Download the DRS 7.10 software zip file from the Web License Portal.
CAUTION: Ensure you download DRS version 7.10 or later.

b) Once the archive downloads, extract it. The archive creates a new DRS 7.10 folder containing the
following files:
• DeviceRegistrationService.zip
• DRS 7.10 Release Notes.htm
• DRS 7.10 User and Client Guide
• Equitrac_Third_Party-Readme.pdf
c) Unzip the DeviceRegistrationService.zip. This creates a new folder containing the
DeviceRegistrationService.exe.
d) Run the DeviceRegistrationService.exe file, and follow the instructions to install DRS. For
specific instructions, see the DRS 7.10 User and Client Guide included in your download archive.
2. Install Samsung Smart UX.
a) Download the most recent version of Samsung Smart UX from the Web License Portal.
b) Once the archive downloads, extract SmartUXServices<build-number>.zip. The archive
contains the SamsungSmartUX-prod.apk and SmartUXServices.apk files.
3. Upload the Samsung Smart UX client and server package files to DRS:

417
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

a) Open a web browser and enter http://DRSServerIP:9000/device where DRSServerIP is the IP

address of the server where you installed DRS. The Nuance Device Registration Service
screen opens:

b) Select the Files tab.

c) From the Device Type drop-down list, select Samsung SmartUX.
d) At the bottom of the screen, click the Upload button. This opens a file explorer, where you can
navigate to the SamsungSmartUX-prod.apk and SmartUXServices.apk files and upload
these files.
4. Create the application in DRS:
a) Select the Applications tab.

b) Click the green ( ) button at the top of the left Applications pane. The Add Application function
loads into the right pane.
c) In the Name field (required), enter a name for the application. You can use any name you like; for
this example, Samsung Smart UX was used.
d) In the Application Type field (required), select Samsung SmartUX.
e) From the Server configuration drop-down list, select AutoStore only.
f) In the AutoStore Server Address field (required), enter the IP address used by the AutoStore
Server.
g) In the AutoStore Server Port field, enter the server port used by the AutoStore Server.
h) In the AutoStore Server use SSL field, select True or False (it should match what is on the
Preferences tab of the Samsung Smart UX component).
i)
Click the Save button ( ) at the top of the Add Application screen.
5. Add a device in DRS:
a) Select the Devices tab.

418
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

b) Click the green ( ) button at the top of the left Devices pane. The Add Device function loads
into the right pane.
c) In the Name field (required), enter a name for the Samsung Smart UX device or device group that
identifies it on the network.
d) In the Address field (required), enter the IP address of the device.
e) Enter the Username and Password for the device. By default, the username is admin and the
password is left blank.
f) From the Application drop-down list (required), select the application you created. In this
example, Samsung Smart UX. The rest of the Add Device fields appear below.
g) In the Device use SSL field, select True or False (Device use SSL should match SSL settings
on a device).
h) In the Client Package field (required), select SamsungSmartUX-prod.apk - Nuance
Unified Client for Samsung Smart UX <build-number> from a list of uploaded
packages.
i) In the Server Package field (required), select SmartUXServices.apk - Smart UX License
Management <version-number> from a list of uploaded packages.
j)
Click the Save ( ) button at the top of the Add Device pane.
6. Execute final actions. Once you save the Device, a new Select Action... drop-down list displays at
the top of the Devices pane. The following actions are available:

419
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

•
To install, select Install and click the Run Action icon ( ) to run the action. This may take a few
moments to complete; once finished, a Successfully completed message appears in the Action
History pane at the bottom of the screen.
•
To uninstall, select Uninstall and click the Run Action icon ( ) to run the action. This may take
a few moments to complete; once finished, a Successfully completed message appears in the
Action History pane at the bottom of the screen.
•
To configure, select Configure and click the Run Action icon ( ) to run the action. This may
take a few moments to complete; once finished, a Successfully completed message appears in
the Action History pane at the bottom of the screen.
7. Add and configure Samsung Smart UX component to an AutoStore workflow. For more information,
see Device Registration Service User Guide and AutoStore Administration Guide.

Quick Setup Process for Equitrac

Follow these steps to perform an installation of Samsung Smart UX for an Equitrac only environment:
Note: All steps outlined are performed from the server where the installation takes place.
Administrative access to the server is required.

1. Install DRS.
a) Download the DRS 7.10 software zip file from the Equitrac partner portal.
CAUTION: Ensure you download DRS version 7.10 or later.

b) Once the archive downloads, extract it. The archive creates a new DRS 7.10 folder containing the
following files:
• DeviceRegistrationService.zip
• DRS 7.10 Release Notes.htm
• DRS 7.10 User and Client Guide
• Equitrac_Third_Party-Readme.pdf
c) Unzip the DeviceRegistrationService.zip. This creates a new folder containing the
DeviceRegistrationService.exe.
d) Run the DeviceRegistrationService.exe file, and follow the instructions to install DRS. For
specific instructions, see the DRS 7.10 User and Client Guide included in your download archive.

420
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Although you can deploy DRS to any server as long as there is no port conflict, a best practice
is to install the DRS wherever the Equitrac is installed. In this way, the DRS server can control the
same MFP devices that are controlled by the corresponding Equitrac server.
2. Install Samsung Smart UX.
a) Download the most recent version of Samsung Smart UX from the Equitrac Partner Portal.
Note: The downloaded files reference Samsung Smart UX. These are still the valid files
needed for an Equitrac only deployment.

b) Once the archive downloads, extract SmartUXServices<build-number>.zip. The archive

contains the SamsungSmartUX-prod.apk and SmartUXServices.apk files.
3. Upload the Samsung Smart UX client and server package files to DRS:
a) Open a web browser and enter http://DRSServerIP:9000/device where DRSServerIP is the IP
address of the server where you installed DRS. The Nuance Device Registration Service
screen opens:

b) Select the Files tab.

c) From the Device Type drop-down list, select Samsung SmartUX.
d) At the bottom of the screen, click the Upload button. This opens a file explorer, where you can
navigate to the SamsungSmartUX-prod.apk and SmartUXServices.apk files and upload
these files.
4. Create the application in DRS:
a) Select the Applications tab.

b) Click the green ( ) button at the top of the left Applications pane. The Add Application function
loads into the right pane.
c) In the Name field, enter a name for the application. You can use any name you like; for this
example, Samsung Smart UX was used.
d) In the Application Type field (required), select Samsung SmartUX.
e) From the Server Configuration drop-down list, select Equitrac only.

421
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Each embedded device entry in System Manager must be associated with a physical
device (MFP). Once Samsung Smart UX is installed, your device communicates with Equitrac
specified during the installation and configuration via the DRS component and an embedded
device entry is automatically created in the Equitrac Office or Equitrac Express system, only if
you applied the software license before installing the software on the MFP.
f) In the DCE Server Address fields, enter the IP addresses used by the Equitrac Server.
g)
Click the Save button ( ) at the top of the Add Application screen.
5. Add a device in DRS:
a) Select the Devices tab.

b) Click the green ( ) button at the top of the left Devices pane. The Add Device function loads
into the right pane.
c) In the Name field (required), enter a name for the Nuance Unified Client for Samsung Smart UX
device or device group that identifies it on the network.
d) In the Address field (required), enter the IP address of the device.
e) Enter the Username and Password for the device. By default, the username is admin and the
password is left blank.
f) From the Application drop-down list (required), select the application you created. In this
example, Samsung Smart UX. The rest of the Add Device fields appear below.
g) In the Device use SSL field, select True or False (Device use SSL should match SSL settings
on a device).
h) In the Client Package field (required), select SamsungSmartUX-prod.apk - Nuance
Unified Client for Samsung Smart UX <build-number> from a list of uploaded
packages.
i) In the Server Package field (required), select SmartUXServices.apk - Smart UX License
Management <version-number> from a list of uploaded packages.
j)
Click the Save ( ) button at the top of the Add Device pane.
6. Execute final actions. Once you save the Device, a new Select Action... drop-down list displays at
the top of the Devices pane. The following actions are available:

422
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

•
To install, select Install and click the Run Action icon ( ) to run the action. This may take a few
moments to complete; once finished, a Successfully completed message appears in the Action
History pane at the bottom of the screen.
•
To uninstall, select Uninstall and click the Run Action icon ( ) to run the action. This may take
a few moments to complete; once finished, a Successfully completed message appears in the
Action History pane at the bottom of the screen.
•
To configure, select Configure and click the Run Action icon ( ) to run the action. This may
take a few moments to complete; once finished, a Successfully completed message appears in
the Action History pane at the bottom of the screen.
7. Locate the auto-added device and configure it in Equitrac System Manager. For instructions see the
Server-Side Configuration section of Device Registration Service User Guide.

Quick Setup Process for AutoStore and Equitrac

Follow these steps to perform an installation of Samsung Smart UX for AutoStore and Equitrac
environment:
Note: All steps outlined are performed from the server where the installation takes place.
Administrative access to the server is required.

1. Install DRS.
a) Download the DRS 7.10 software zip file from the Equitrac partner portal.
CAUTION: Ensure you download DRS version 7.10 or later.

b) Once the archive downloads, extract it. The archive creates a new DRS 7.10 folder containing the
following files:
• DeviceRegistrationService.zip
• DRS 7.10 Release Notes.htm
• DRS 7.10 User and Client Guide
• Equitrac_Third_Party-Readme.pdf
c) Unzip the DeviceRegistrationService.zip. This creates a new folder containing the
DeviceRegistrationService.exe.

423
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

d) Run the DeviceRegistrationService.exe file, and follow the instructions to install DRS. For
specific instructions, see the DRS 7.10 User and Client Guide included in your download archive.
Note: Although you can deploy DRS to any server as long as there is no port conflict, a best practice
is to install the DRS wherever the Equitrac is installed. In this way, the DRS server can control the
same MFP devices that are controlled by the corresponding Equitrac server.
2. Install Samsung Smart UX.
a) Download the most recent version of Samsung Smart UX from the Equitrac Partner Portal.
b) Once the archive downloads, extract SmartUXServices<build-number>.zip. The archive
contains the SamsungSmartUX-prod.apk and SmartUXServices.apk files.
3. Upload the Samsung Smart UX client and server package files to DRS:
a) Open a web browser and enter http://DRSServerIP:9000/device where DRSServerIP is the IP
address of the server where you installed DRS. The Nuance Device Registration Service
screen opens:

b) Select the Files tab.

c) From the Device Type drop-down list, select Toshiba Unified Client.
d) At the bottom of the screen, click the Upload button. This opens a file explorer, where you can
navigate to the SamsungSmartUX-prod.apk and SmartUXServices.apk files and upload
these files.
4. Create the application in DRS:
a) Select the Applications tab.

b) Click the green ( ) button at the top of the left Applications pane. The Add Application function
loads into the right pane.
c) In the Name field, enter a name for the application. You can use any name you like; for this
example, Samsung Smart UX was used.

424
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

d) From the Application Type drop-down list, select Samsung SmartUX. New options then display
below.
e) From the Server Configuration drop-down list, select AutoStore and Equitrac.
f) In the AutoStore Server Address field (required), enter the IP address used by the AutoStore
Server.
g) In the AutoStore Server Port field, enter the server port used by the AutoStore Server.
h) In the AutoStore Server use SSL field, select True or False (it should match what is on the
Preferences tab of the Samsung Smart UX component).
i) In the DCE Server Address fields, enter the IP addresses used by the Equitrac Server.
j)
Click the Save button ( ) at the top of the Add Application screen.
5. Add a device in DRS:
a) Select the Devices tab.

b) Click the green ( ) button at the top of the left Devices pane. The Add Device function loads
into the right pane.
c) In the Name field (required), enter a name for the Samsung Smart UX device or device group that
identifies it on the network.
d) In the Address field (required), enter the IP address of the device.
e) Enter the Username and Password for the device. By default, the username is admin and the
password is left blank.
f) From the Application drop-down list (required), select the application you created. In this
example, Samsung Smart UX. The rest of the Add Device fields appear below.
g) In the Device use SSL field, select True or False (Device use SSL should match SSL settings
on a device).
h) In the Client Package field (required), select SamsungSmartUX-prod.apk - Nuance
Unified Client for Samsung Smart UX <build-number> from a list of uploaded
packages.
i) In the Server Package field (required), select SmartUXServices.apk - Smart UX License
Management <version-number> from a list of uploaded packages.
j)
Click the Save ( ) button at the top of the Add Device pane.
6. Execute final actions. Once you save the Device, a new Select Action... drop-down list displays at
the top of the Devices pane. The following actions are available:

425
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

•
To install, select Install and click the Run Action icon ( ) to run the action. This may take a few
moments to complete; once finished, a Successfully completed message appears in the Action
History pane at the bottom of the screen.
•
To uninstall, select Uninstall and click the Run Action icon ( ) to run the action. This may take
a few moments to complete; once finished, a Successfully completed message appears in the
Action History pane at the bottom of the screen.
•
To configure, select Configure and click the Run Action icon ( ) to run the action. This may
take a few moments to complete; once finished, a Successfully completed message appears in
the Action History pane at the bottom of the screen.
7. Locate the auto-added device and configure it in Equitrac System Manager. For instructions see the
Server-Side Configuration section of Device Registration Service User Guide. Besides configuring
Equitrac server, you can also add and configure Samsung Smart UX component to an AutoStore
workflow. For more information, see Device Registration Service User Guide and AutoStore
Administration Guide.

426
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for

Toshiba v1.0

AutoStore Deployment Guide

AutoStore Solution Overview
Version 1.0 of the Nuance Unified Client for Toshiba provides a unified client for capture and print
management functionality on specific Toshiba-manufactured Multi-Function Printers (MFPs). When
deployed to the MFP, Nuance Unified Client for Toshiba v 1.0 controls access to the MFP and acts as
the gateway for Nuance functionality.
This document will walk you through a clean installation procedure. Follow the steps provided here to be
able to have an AutoStore Send to Folder capture workflow configured on your Toshiba MFP device.

Basic workflow
1. Prepare for deployment
a. Verify that your device is supported
b. Verify prerequisites
c. Get installer packages (AutoStore, DWS, DRS and Toshiba client packages)
2. Install the AutoStore server
3. Install Device Web Service (DWS) standalone
4. Configure the Toshiba MFP
a. Install SSL/TLS root certificate
b. Import or create the device certificate on the device
c. Verify and confirm DNS configuration
d. Ensure that SSL/TLS is enabled
e. Verify that previous applications are cleared
5. Install and Setup Device Registration Service (DRS)
a. Upload Toshiba Client Package
b. Create application.
c. Add the device
d. Install and register
6. Create your first workflow and verify installation
a. License AutoStore

427
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

b. Configure Send to Folder workflow

c. Verify installation

Prepare for Deployment

Verify that your device is supported
For the latest list of supported Toshiba models, consult your local Toshiba representative or refer
to Nuance Supported Device Search webpage (https://nuanceimaging.custhelp.com/app/imaging/
supported_devices?mfr=164).

Verify prerequisites
Before starting deployment ensure that the following requirements are met. These are targeting a
satisfying user experience when you are doing a single-server installation of AutoStore, Device Web
Server (DWS) and Device Registration Service (DRS).

Check Description

Verify that the server machine is a member of a domain.

Ensure that the following hardware requirements are met:

• 8 GB of physical memory available
• 5 GB of hard disk space available (including SQL server and prerequisites)
• The CPU is 4 x 2 GHz or greater

Check that the operating system is one of the following 64-bit ones:
• Windows Server 2012 R2
• Windows Server 2012 - Standard and Datacenter (enable ASP.NET for
Microsoft .NET 4.5 or ASP.NET for Microsoft .NET 4.6. before installation)
• Windows Server 2008 R2
• Windows Server 2008 - Standard, Enterprise and Datacenter

Verify that you have Administrative access rights to Windows on the server.

Check that all required Windows updates are installed

Verify that Microsoft Windows Updates is turned ON while you are deploying
AutoStore. This is necessary for the successful installation of Microsoft Windows
Identity Foundation (TFS).

Ensure that .NET Framework 3.5 is installed on the server (to verify it, launch Server
Manager > select Local Server > verify that .NET Framework 3.5 is listed under
Roles and Features). If it is missing it will be installed as part of the AutoStore
installation process.

Ensure that Windows Identity Foundation 3.5 is installed on the server (to verify
it, launch Server Manager > select Local Server > verify that Windows Identity
Foundation 3.5 is listed under Roles and Features).

428
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description

Allow incoming firewall exceptions for the following ports:

• 80: Device port used for HTTP connections
• 443: Device port used for HTTPS connections to the device
• 3310: Capture server port
• 8080: Redirects to port 8444 used for HTTPS communication to the DWS
• 8444: Each request to the DWS from the MFP uses the DWS address as specified
in DRS (TLS connections using port 8444). It is these requests and events from the
MFP to DWS that will request the DWS server certificate when completing a TLS
handshake. Also used by Web Administration page
• 8753: The default port for the Device Registration Service Web Service
• 9000: The port used by the server to communicate with the web client. This port is
specified in the Service settings in the DRS Device Configuration Manager
and outgoing firewall exceptions for ports 3310, 8753, 49629, 49630, 50083. (Note
that port 3310 is configurable and you should update your firewall accordingly).

Verify that IE Enhanced Security Configuration is turned OFF for Administrators in IE

Enhanced Security Configuration (to access this, go to Server Manager > then
select Local Server).

Check that you have all required components downloaded and within easy reach
(components and download locations are listed in the section below).

If you are planning to use any AutoStore Route component that requires client
software, ensure that this software is installed on your server machine before starting
deployment.

Verify that you have Administrative access to the device.

Check that your server(s) and MFP(s) have a DNS A record.

Due to a security update Toshiba devices may no longer show a login page after
updating DWS. Initialize the device with client package 1.0.6945 to resolve the issue.

Get installer packages

Download the client installation packages for AutoStore, the Toshiba Unified Client, DWS and DRS
from the Web Licensing Portal (https://weblicense.nsius.com/). Select these products in the list under
Software Download and Documents to access the packages.
1. Log in to the Web Licensing Portal.
2. Under Software Download and Documents, select the product AutoStore 7 or later from the list.
and download the AutoStore 7 SP4 or later executable as well as available documentation.
3. Under Software Download and Documents, select the product Device Registration Service
(DRS). Download the executable DRS file (9078-DRS7.9Patch2.zip or later) as well as available
documentation.
4. Under Software Download and Documents > Device Registration Service, select the product
Toshiba Unified Client. Download the client zip package as well as available documentation.
5. Under Software Download and Documents, select the product Device Web Service (DWS)
Standalone. Download the executable DWS Standalone as well as available documentation.

429
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

It is recommended to dedicate a folder to all of your downloads for quick and easy access.

Install the AutoStore Server

Once you have verified that all prerequisites are met and all necessary downloads are available,
you can start deploying the package. Start by installing the AutoStore server. Follow the component
installation order described in this document.

Install AutoStore
DOUBLE-CHECK BEFORE YOU START: Before running the AutoStore installer, ensure that you have
the latest system updates on your machine and that Automatic Windows Updates are turned ON.
1. Extract the AutoStore zip file you have downloaded. Inside the folder created during extraction go
into AutoStore installation folder.
2. Select the installation executable file, right-click it and choose Run as administrator.
3. If the installation wizard prompts you to install prerequisite software, click Install.
4. After prerequisite software has been installed, click Next.
5. At this point, you may or may not be prompted to reboot. If you are prompted, reboot your machine.
6. Review and accept the license agreement.
7. On the Customer Information screen, type a user name and organization.
8. On the Custom Setup screen, select all AutoStore components to install. By default, all capture and
process components are selected for installation.
Note: 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.
9. 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.
10.On the Ready to Install the Program screen, click Install.

Install Device Web Service Standalone

DWS Installation
The Device Web Server (DWS) Standalone manages and controls embedded applications on web-
based multi-function printers (MFPs).
DOUBLE-CHECK BEFORE YOU START: As per the prerequisites, the solution requires a properly
configured DNS to exist on the network to which the MFP is being added.
Specifically, the Windows Server on which the DWS Standalone server will be installed needs to be able
to perform DNS hostname resolution.
Installation steps:
1. Extract the DWS zip file package you have downloaded.
2. Run the installation executable file (DeviceWebServer.msi).
3. On the Welcome screen, click Next to begin the installation process.
4. Read and accept the terms of the Nuance End User License Agreement and click Next.
5. On the Destination Folder screen, accept the default installation folder or click Change to select a
new folder. Click Next.
6. Click Install and then Finish to complete the installation.

430
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. Go to All Programs > Nuance > Device Registration Service > Device Configuration Manager.
8. In Service under Service Actions > Action, click Start.
9. Under Service > Service Settings open http://<localhost>:9000.
Note: It may take a few minutes to activate for the first time.

Setup the Toshiba MFP

Configure the Toshiba MFP in Nuance Unified Client Environment

BEFORE YOU START

Important: Verify that the device has the correct timezone, date and time set: Navigate to
Administration > Setup > General and check date, time and timezone.

Install SSL/TLS root certificate

TopAccess is a web-based device management tool that allows you to access information about the
Toshiba multifunctional system via the network.
1. Go to C:\Windows\System32\config\systemprofile\AppData\Local\Nuance\Integrated\DWS
\webserver\conf\ and copy the dws-root-ca.der file in a location easily accessible to you.
2. Launch a web browser and enter the following URL in the address box: http://<IP Address> or http://
<Device Name> of your MFP. This will open the TopAccess website and let you configure your
device.
3. In TopAccess, navigate to Administration > Security > Certificate Management.
4. Delete any existing CA certificates from the device.
5. Under CA certificate, select CA certificate (DER).
6. Press Choose File. Select the dws-root-ca.der file you have previously copied.
7. Press Upload and save your changes.

Import or create the Device Certificate on the Toshiba device

The Device Certificate must be imported or created on the device to allow the device to trust HTTPS
connections to DWS.
1. For the connection from the Device Web Server (DWS) to the device to work correctly, the device
needs to have a valid certificate that is based on the correct hostname of the device.
a. If the device is set to DHCP the hostname and domain name can be set by the DHCP server.
b. Otherwise, you can manually specify the device’s hostname/fully qualified domain name (that is,
not the IP address) on TopAccess under Administration > Setup > Network.
c. Set hostname first, under Host name.
d. Go to DDNS > Domain Name and set the fully qualified domain name.
Note: The DDNS A record must match this domain name.

2. Navigate to Administration > Security > Certificate Management.

a. Create a self-signed device certificate.
b. Save your changes.
3. Export a self-signed device certificate.
4. Verify date and time and make sure you are in the right time zone by clicking the Details tab.

431
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

5. Reboot your MFP.

Ensure SSL/TLS is enabled for ODCA on the Toshiba Device

1. Navigate to TopAccess > Administration > Setup > ODCA.
2. Verify that the SSL port is enabled and that you know the port number. By default, it is 49630.

Ensure that previous applications are cleared

If you had previous solutions configured on the device and these have not been removed properly you
need to clear any existing ODCA Notification Events. In TopAccess, select Administration > Setup >
ODCA > Delete All.
This action should only be performed if previous applications were not properly removed from the
device.

Install Device Registration Service

Quick Setup Device Registration Service Instructions
BEFORE YOU START: Administrative access to the server is required. All steps outlined are performed
from the server where the installation takes place. In Start menu under Administrative Tools go to
Server Manager > Local Server > IE Enhanced Security Configuration > turn off Administrators.
Note: When creating an application, use the fully qualified domain instead of the IP address.

1. Install DRS.
a) Download and unzip the DeviceRegistrationService.zip. This creates a new folder
containing the DeviceRegistrationService.exe.
b) Select the installation executable file, right-click it and choose Run as administrator.
c) Run the DeviceRegistrationService.exe file, and follow the instructions to install DRS.
2. Upload Toshiba Client Package.
a) Download the most recent version of Nuance Unified Client for Toshiba v 1.0 from the Web
License Portal.
b) Once the archive downloads, extract ToshibaUC_1.0.<build-number>.zip. The archive
contains the ApplicationPackage.xml file.
c) Upload the Toshiba client package file to DRS: Open a web browser and enter http://
DRSServerIP:9000/device, where DRSServerIP is the IP address of the server where you
installed DRS. The Nuance Device Registration Service screen opens:

432
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

d) Select the Files tab.

e) From the Device Type drop-down list, select Toshiba Unified Client.
f) At the bottom of the screen, click the Upload button. This opens a file explorer, where you can
navigate to the ToshibaUC_1.0.<build-number>.zip and upload it.

Note: Future updates of the client configurations can be also uploaded from here.

The Administrator can check build information for the specific package version and DRS decides
what should be installed to the MFP based on the device configurations.

The Administrator can also install the latest version of the client, or a previous version (until that
version is retired or is not supported).

433
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Create the application in DRS.

a) Select the Applications tab.

b) Click the green ( ) button at the top of the left Applications pane. The Add Application function
loads into the right pane.
c) In the Name field (required), enter a name for the application. You can use any name you like; for
this example, 'Toshiba' was used.
d) In the DWS Service Address field (required), enter the DWS hostname (this address can be also
used for multiple devices) or the FQDN of the DWS server.
e) From the Server Configuration drop-down list, select AutoStore only.
f) In the AutoStore Server Address field (required), enter the IP address used by the AutoStore
Server.
g) In the AutoStore Server Port field, enter the server port used by the AutoStore Server. The
default value is 3310.
h) In the AutoStore Server use SSL field, select True or False. This setting should reflect your
AutoStore Server configuration. Verify it in the Preference tab of Nuance Unified Client for
Toshiba v 1.0 component. By default, the AutoStore setting "Use SSL" is OFF. If you leave it as
OFF, you should select False in DRS.
i)
Click the Save button ( ) at the top of the Add Application screen.
4. Add the device in DRS.
a) Select the Devices tab.

434
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

b) Click the green ( ) button at the top of the left Devices pane. The Add Device function loads
into the right pane.
c) In the Name field (required), enter a name for the Toshiba device or device group that identifies it
on the network.
d) In the Address field (required), enter the IP address of the device.
e) Enter the Username and Password for the device. By default, the username is admin and the
password is 123456.
f) From the Application drop-down list (required), select the application you created. In this
example, Toshiba. The rest of the Add Device fields appear below.
g) In the Device Group field, specify the name of the Device Group.
h) In the Port number field (required), set the default port number (SSL). There are separate port
numbers for SSL and non-SSL mode depending on whether Device use SSL is true or false,
Device Port (SSL) or Device Port are available to the user.
i) In the Client Package field (required), select ToshibaUC_1.0.<build-number>.zip from a
list of uploaded packages.
j)
Click the Save ( ) button at the top of the Add Device pane.
5. Install and register. This step installs AutoStore onto the device and registers the device with DWS.
a. From the drop-down list at the top of the Details pane, select Install and Register.

b.
Click the Run Action button . The installation and registration action may take a few moments
to complete. Once finished, a Successfully completed message appears in the Action History
pane at the bottom of the screen.

Set Up Your First Capture Workflow

At this point in the deployment workflow, you should already have a fully functioning installation. To
verify this, create and configure a very simple capture workflow (Send to Folder) and test it on your
device.

License AutoStore
This is the prerequisite step before you can start configuring your first AutoStore workflow.

435
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

1. Launch the AutoStore 7 Process Designer.

2. Go to Home > License Manager > License Request File and save the request as a text (.txt) file to
Desktop.
3. Go to Home > License Manager > Web License.
4. The NSi Web License website (https://weblicense.nsius.com/) opens in a browser. Log in and select
AutoStore 7.
Note: If you are a new user, register your user information. Email addresses from free email
services such as Gmail or Hotmail cannot be used.

5. Go to Downloads > License Activation and select your License Type.

6. Go to Downloads > License Activation > Order and License Request and upload the License
Request file from Desktop.
7. Click Submit once. An activated license file is sent to you by email. Save the received license file
and note the location.
8. In the AutoStore 7 Process Designer go to Home > License Manager > Load License Key File and
select downloaded license file. Click OK to apply the license.
9. Close the AutoStore 7 Process Designer for license to be applied.

Configure Scan to Folder

1. Select the Home tab and choose New.

2. Click OK on the Task Properties dialog and drag the Toshiba Unified Client icon from the left side
of the AutoStore Process Designer Toolbox anywhere on the newly created workflow canvas on
the right side of the screen.
3. From the Toolbox > Capture icons, click and drag the Nuance Unified Client for Toshiba v 1.0
component to an AutoStore workflow to provide capture functionality for Toshiba devices on which
the Nuance Unified Client for Toshiba v 1.0 is installed.
4. Scroll down to the bottom of the Toolbox list and click and drag Send to Folder to the workflow.

5. Right-click on the Toshiba Unified Client icon and select Properties.

6. Select the Preferences tab. Your settings under Server must match the ones you specified in DRS.
If you kept the default values there, type 3310 in the Web Server Port field, and leave Use SSL
unchecked. Otherwise, ensure that these values match the ones you set in DRS.

436
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

7. Select the Groups tab, and click on Common Group for the Toshiba component configuration.
8. Select Add Form > Basic Form. Name the form 'Sample' and click on the Components tab to
configure the folder to route the scan to.
9. Select ... and add the path of the destination folder.
10.Click ... next to Folder path and create a folder such as c:\Scans to send scans to. Check off
Rename file to ensure file names are unique.

11.Click OK.
12.Click Save and save the configuration to a folder such as c:\asconfigs.
13.Click Start at the top of Process Designer. You should now be able to start and use this workflow
from the MFP.
AutoStore has a lot more capture workflows to offer. Consult the downloaded product documentation on
how to set those up.

Equitrac Deployment Guide

Equitrac Solution Overview
Version 1.0 of the Nuance Unified Client for Toshiba provides a unified client for capture and print
management functionality on specific Toshiba-manufactured Multi-Function Printers (MFPs). When
deployed to the MFP, Nuance Unified Client for Toshiba v 1.0 controls access to the MFP, and acts as
the gateway for Nuance functionality.
File names provided in this document refer to both Equitrac Office and Equitrac Express. To set up the
functionality described in this guide, you can choose to select either - as long as you are consistent in
your choice throughout the process.
This document will walk you through a clean installation procedure in Equitrac Office/Express
standalone deployment. Also described is how to set up your first print workflow (Follow-You Printing)
on your Toshiba MFP device. If you want to go beyond these initial steps, ensure that you are consulting
the relevant Office/Express sections of the Equitrac product documentation.

Basic workflow
1. Prepare for deployment
a. Verify that your device is supported

437
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

b. Verify prerequisites
c. Get installer packages (Equitrac Office/Express 5.7 with the latest hotfixes, DRS 7.9 and Toshiba
client package)
2. Install the Equitrac server
3. Configure the Toshiba MFP
a. Install SSL/TLS root certificate
b. Import or create the device certificate on the device
c. Ensure that SSL/TLS is enabled
d. Verify that previous applications are cleared
4. Install and Setup Device Registration Service (DRS)
a. Upload Toshiba Client Package
b. Verify that previous applications are cleared
c. Create application.
d. Add the device
e. Install and register
f. Add and configure your device
5. Create your first workflow and verify installation
a. License Equitrac
b. Configure Follow-You Printing workflow

Prepare for Deployment

Verify that your device is supported
For the latest list of supported Toshiba models, consult your local Toshiba representative or refer
to Nuance Supported Device Search webpage (https://nuanceimaging.custhelp.com/app/imaging/
supported_devices?mfr=164).

Verify prerequisites
DOUBLE-CHECK BEFORE YOU START: Before starting deployment ensure that the following
requirements are met. These are targeting a satisfying user experience when you are doing a single-
server installation.
Before installing Equitrac Office/Express and Device Registration Service (DRS) ensure that the
machine you plan to use meets the operating requirements outlined below. Observe that you MUST
have a 64-bit version of operating system.
Note: For Windows Servers 2008, 2008 R2, 2012, 2012 R2 and 2016, make sure the server is up
to date with the latest service packs, or manually download and install the latest version of Windows
Installer from Microsoft. Windows Installer 4.5 is required to install Equitrac 5.7.

Check Description

Verify that the server machine is a member of a domain.

438
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description

Ensure that the following hardware requirements are met:

• 8 GB of physical memory available
• 5 GB of hard disk space available (including 2 GB dedicated to DWS)
• The CPU is 4 x 2 GHz or greater

Ensure that you have Microsoft SQL Server 2008/2008 Express SP3 or later
installed.

Verify that you have one of the following supported operating systems
installed:
• Windows Server 2008 (x64 with IIS 7.0 and .NET 4.5)
• Windows Server 2008 R2 (x64 with IIS 7.5 and .NET 4.5)
• Windows Server 2012 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2012 R2 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2016 (x64 with IIS 10.0 and .NET 4.6)

Verify that you have Administrative access rights to Windows on the

server.

Check that all required Windows updates are installed.

Allow incoming firewall exceptions for the following ports:

• 80: Device port used for HTTP connections
• 443: Device port used for HTTPS connections to the device
• 587: SMTP Email server port used if TLS is enabled
• 2939: SSL is always on for Equitrac and the default port setting of 2939
is not configurable in DRS
• 8080: Redirects to port 8443 used for HTTPS communication to the DWS
• 8443: Each request to the DWS from the MFP uses the DWS address
as specified in DRS (TLS connections using port 8443). It is these
requests and events from the MFP to DWS that will request the DWS
server certificate when completing a TLS handshake. Also used by Web
Administration page
• 8753: The default port for the Device Registration Service Web Service
• 9000: The port used by the server to communicate with the web
client. This port is specified in the Service settings in the DRS Device
Configuration Manager

Verify that IE Enhanced Security Configuration is turned OFF for

Administrators in IE Enhanced Security Configuration (to access this, go
to Server Manager and then select Local Server).

Check that you have all required components downloaded and within
easy reach (components and download locations are listed in the section
below).

439
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description

Verify that you have Administrative access to the device.

Check that your server(s) and MFP(s) have a DNS A record as well as a
reverse lookup entry in DNS.

Get installer packages

The following components are required for installing the Nuance Unified Client for Toshiba v 1.0
software in Equitrac Office/Express deployment:
• Equitrac Office/Express 5.7 (build 28.7293) or later with latest hotfixes available for Windows
Server platforms installed: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/) and
download the EO5.7a.zip / EE5.7a.zip file under TECH SUPPORT > Software Downloads
> Equitrac Express or Equitrac Office. Download all available hotfixes under TECH SUPPORT
> Hot Fixes. After that, download Equitrac Office/Express 5.7 related documentation under TECH
SUPPORT.
• Device Registration Service: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/)
and download the executable DRS file (9078-DRS7.9Patch2.zip or later) as well as available
documentation under TECH SUPPORT > Software Downloads > Device Registration Service
(DRS) > DRS 7.9 Patch 2 .
• Toshiba Client Package: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/) and
download the ToshibaUC.<version_number>.zip file as well as available documentation under TECH
SUPPORT > Software Downloads > Toshiba Unified Client.
It is recommended to dedicate a folder to all of your downloads for quick and easy access.

Install Equitrac
This section provides the steps required to install Equitrac Office/Express on a single machine. A “Local”
installation places all Equitrac Office/Express server components and Administrative Applications on a
single machine. This type of installation is appropriate for small site deployment.
DOUBLE-CHECK BEFORE YOU START: Ensure that you have Microsoft SQL Server 2008/2008
Express SP3 or later installed.

Single machine installation

When installing Equitrac Office/Express, the installation wizard allows you to select the server
components and features to install per machine. For a local installation, install all server components on
the same machine.

Install the Equitrac server

In this document, file names are provided for both Equitrac Office and Equitrac Express. To set up the
functionality described in this guide, you can choose to select either - as long as you are consistent in
your choice throughout the process. .
Once you have verified that all prerequisites are met and all necessary downloads are available, you
can start deploying the package. Complete the following:
1. Close all other applications on the server prior to running the Equitrac Office/Express installation.
2. Unzip the downloaded EO5.7a.zip / EE5.7a.zip file.
3. Select and run the Installer file (Equitrac.Office.exe / Equitrac.Express.exe) to launch
the 64-bit Equitrac Office/Express Installation wizard.

440
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Read and accept the terms of the Nuance End User License Agreement, and click Install to
continue.
5. At the Welcome screen, click Next to begin the installation process.
6. On the Select language screen, choose the interface language and select Standard Install.
7. On the Select Features screen, expand Device Control Engine (DCE) and select Device Web
Service (DWS) component and deselect other components.

8. Expand Document Routing Engine (DRE) and select I-Queue component.

9. (optional) Expand and select Scan Processing Engine (SPE) service.
10.(optional) Expand and select Device Control Service (DCS) if you are to use Ethernet Card
Readers.
11.Click Next.
12.On the Service Log On Credentials screen, enter the account and password (SQL server: admin/
sa) of the user who will run the Windows services. Alternatively, click Browse to search for valid user
from a specific location. Click Test Credentials to verify the user, and click Next to continue.
13.On the Windows Firewall Exceptions screen, select either a manual or automatic setup method
for the firewall exceptions. Click Next.
14.On the Database platform screen, proceed with default selection (SQL Server) and click Next.
15.Select available database server from the Database Instance list, and then click Next. Alternatively,
the database server address, and optionally the instance name, can be typed in the Database
Instance field.
16.On the Database credentials screen, select the authentication type of the selected SQL Server:
• Windows Authentication (default selection): select this option when the user running the
Windows Service account connects to the database server. This user was specified on the
Service Log On Credentials screen
• SQL Authentication: enter the user credentials in the Login and Password fields, (this can be
another Windows user or a SQL Server user)
17.Click Test Connection to check the connection to the database with the selected user, then click
Next.

441
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

18.If the specified SQL Express database (“eqcas”) already exists (for example, in the case of an
upgrade), the Database Already Exists screen appears. Select whether to Replace or Keep the
existing database, and click Next.
19.If any of the Web Client features are selected for installation, the Web Client - Application Pool
screens appears. Turn on the Application Pool and test it.
20.On the Web Client - Single Sign-On screen, select the Single Sign-On feature and click Next.
21.On the DCE High Availability Setup screen, do not select the DCE will be part of a High
Availability setup check box. Click Next.
22.On the DCE Local Cache Connection screen, create the Administrator account and Password to
use with Distributed Cache, and click Next.
23.On the Ready to install Equitrac Office/Express screen, click Install.
24.Once installed, click Finish to exit the Equitrac Office/Express Installation wizard.

Install the Equitrac hotfixes

After installing the Equitrac server, install the latest hotfixes you have downloaded from the Partner
Portal (in http://partners.equitrac.com under TECH SUPPORT > Hot Fixes):
• HF-301255-CAS (or later)
• HF-306025-DRE (or later)
• HF-300924-DCE (or later)
• HF-296892-DWS (or later)
• HF-299304-DCS (or later)
• HF-299304-SysMgr (or later)
• HF-288508-WebClient (or later)
Important: The Core Accounting Server (CAS) hotfix must be installed first. After that, proceed in any
order you wish by following the instructions in the hotfix release notes to complete the installation.

442
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Setup the Toshiba MFP

Configure the Toshiba MFP in Nuance Unified Client Environment

BEFORE YOU START

Important: Verify that the device has the correct timezone, date and time set: Navigate to
Administration > Setup > General and check date, time and timezone.

Install SSL/TLS root certificate

TopAccess is a web-based device management tool that allows you to access information about the
Toshiba multifunctional system via the network.
1. Go to C:\Users\eqservice\AppData\Local\Equitrac\Equitrac Platform Component\EQDWSSrv
\webserver\conf\ and copy the dws-root-ca.der file in a location easily accessible to you.
2. Launch a web browser and enter the following URL in the address box: http://<IP Address> or http://
<Device Name> of your MFP. This will open the TopAccess website and let you configure your
device.
3. In TopAccess, navigate to Administration > Security > Certificate Management.
4. Delete any existing CA certificates from the device.
5. Under CA certificate, select CA certificate (DER).
6. Press Choose File.Select the dws-root-ca.der file you have previously copied.
7. Press Upload and save your changes.

Import or create the Device Certificate on the Toshiba device

The Device Certificate must be imported or created on the device to allow the device to trust HTTPS
connections to DWS.
1. For the connection from the Device Web Server (DWS) to the device to work correctly, the device
needs to have a valid certificate that is based on the correct hostname of the device.
a. If the device is set to DHCP the hostname and domain name can be set by the DHCP server.
b. Otherwise, you can manually specify the device’s hostname/fully qualified domain name (that is,
not the IP address) on TopAccess under Administration > Setup > Network.
c. Set hostname first, under Host name.
d. Go to DDNS > Domain Name and set the fully qualified domain name.
Note: The DDNS A record must match this domain name.

2. Navigate to Administration > Security > Certificate Management.

a. Create a self-signed device certificate.
b. Save your changes.
3. Export a self-signed device certificate.
4. Verify date and time and make sure you are in the right time zone by clicking the Details tab.
5. Reboot your MFP.

Ensure SSL/TLS is enabled for ODCA on the Toshiba Device

1. Navigate to TopAccess > Administration > Setup > ODCA.
2. Verify that the SSL port is enabled and that you know the port number. By default, it is 49630.

443
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Ensure that previous applications are cleared

If you had previous solutions configured on the device and these have not been removed properly you
need to clear any existing ODCA Notification Events. In TopAccess, select Administration > Setup >
ODCA > Delete All.
This action should only be performed if previous applications were not properly removed from the
device.

Configure Device Registration Service

Prepare Device Registration Service for use with Equitrac deployment
DOUBLE-CHECK BEFORE YOU START: Administrative access to the server is required. All steps
outlined are performed on the server where the installation takes place.
1. Install DRS: Download and extract the DRS package DeviceRegistrationService.zip. This
creates a new folder containing the installation executable file as well as product documentation.
Select the installation executable file (DeviceRegistrationService.exe), right-click it and
choose Run as administrator. Follow the instructions to install DRS.
2. Upload Toshiba Client Package: Open a web browser and enter http://DRSServerIP:9000/
device (where DRSServerIP is the IP address of the server where you installed DRS) to open the
DRS web client interface. The Nuance Device Registration Service screen opens:

a) Select the Files tab.

b) From the Device Type drop-down list, select Toshiba Unified Client.
c) At the bottom of the screen, click the Upload button. This opens a file explorer, where you can
navigate to the ToshibaUC.<version_number>.zip and upload. Once upload is complete, the
package appears in the list in the Client Packages column.

444
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. Create an application in DRS (when creating DWS Server Address, use the fully qualified domain
name of the server instead of the IP address):
a) Select the Applications tab.
b) Click the green ( ) button at the top left of the Applications pane.

c) In the Name field (required), enter an application name, for example 'Toshiba'.
d) In the DWS Server Address field (required), enter the Equitrac DWS hostname or the FQDN of
the DWS server.
e) In the Server Configuration list, select Equitrac only.
f) In the DCE Server Address field (required), enter the IP address used by the Equitrac Server.
Note: DCE and DWS must have the same IP address.

g)
Click the Save button ( ).
4. Add a device in DRS:
a) Click the Devices tab.

b) Click the green ( ) button at the top left of the Devices pane. The Add Device function loads
into the right pane.
c) In the Name field (required), enter a name for the Toshiba device or device group that identifies it
on the network.
d) In the Address field (required), enter the IP address of the device.
e) Enter the Username and Password for the device. By default, the username is admin and the
password is 123456.
f) From the Application drop-down list (required), select the application you created (in this
example 'Toshiba'). The rest of the Add Device fields appear below.
g) In the Port number field (required), set the port number (SSL). The port number needs to match
the port set on the device OCDA setting.
h) In the Client Package field (required), select ToshibaUC_1.0.<build-number>.zip from a list of
uploaded packages.
i) (optional) In case a card reader is attached to the device, enter the Card Reader Product ID (PID)
of a USB card reader in the Card Reader PID field (available via AppBlaster from Toshiba).
j) (optional) In case a card reader is attached to the device, enter the Card Reader Vendor ID (VID)
of a USB card reader in the Card Reader VID field (available via AppBlaster from Toshiba).

445
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: Card Readers are only supported in Keyboard Emulation Mode. Use the
Nuance Reader Maintainer Tool available on the Equitrac Partner Portal (https://
partners.equitrac.com/) in the TECH SUPPORT > Software Downloads > Card Readers
section to set it to Keyboard Emulation Mode (the card reader is set to Proprietary Mode by
default).
k)
Click the Save ( ) button at the top of the Add Device pane.
5. Install and register. This step installs Equitrac onto the device and registers the device with DWS:
a) From the drop-down list at the top of the Details pane, select Install and Register.

b)
Click the Run Action ( ) button. The installation and registration action may take a few
moments to complete. Once finished, a Successfully completed message appears in the
Action History pane at the bottom of the screen.

Set Up Your First Print Workflow

At this point in the deployment workflow, you should already have a fully functioning installation. To
verify this, create and configure a simple print workflow (Follow-You Printing) and test it on your device.

Configure Follow-You Printing

To configure Follow-You Printing settings, do the following:
1. Add MFP device in Windows:
a) Use the Windows Operating System’s Add Printer functionality to create the printer definition to
use a standard TCP/IP printer port (choose Device type, add hostname or IP address, and add
Port name). The first time a user prints to the device, the print queue is created automatically.
b) To register the device in the Equitrac database send a test print to the device.
c) Open Equitrac System Manager, and switch to Devices. Within 30 seconds to a minute after
registering the device, the device appears in System Manager. If you do not see a device, first try
refreshing System Manager.
2. Configure a secure queue:
a) Enable secure printing on each device queue. Go to Equitrac System Manager > Devices >
Standard view > expand the physical device to view the print queue for that printer > click the
print queue link to open the Print queue summary dialog box > enable the Secure printing
option in the Behaviour section.
b) In the Physical Device Summary dialog box, select the Release documents from pull group
option. Type in the name of the Pull group (for example, PullGroupA), then click OK to apply the
change (this will be the virtual queue). You only have to type in the name of the Pull group the first
time you use it. Afterward, it appears in the list automatically.
c) Go to the physical device > Release documents from pull group and add it to the same group
as you have created before.

446
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

d) Verify that the virtual and actual physical devices are in the same pull group.
3. Configure Follow-You Printing:
a) In Equitrac System Manager, go to Co > DRE/DRC and Follow-You Printing > Configuration >
Printing.
b) Select the Site where you want Follow-You Printing to be accessible from.
c) In the Settings section, select any of the following options:
• Cost the job before printing – sets the price to a print job based on its properties
• Reprice after release – changes the price of a print job if its properties change after it is
released
• Hide document name in Windows print window – select this option if you do not want
certain documents (such as confidential) from being viewed in the general print queue
• Only print released job while user is logged in to device– if the user logs off prior to
printing the job, the job is put back into the print queue without being released, and the re-
queued print job is not charged to the user
d) In the Space management section, do the following:
• Enter the Job expiry time (this is denoted in hours)
• Enter the Print distribution job expiry time (this is denoted in hours)
e) Select Enabled or Disabled as the global Secure printing default for Follow-You Printing.
f) Select Retrieve username from PJL setting for applications that insert the PJL string into the
print job.
g) In the Number of ports per I-Queue field, enter the number of printer ports (up to 100)
associated with the devices used for I-Queue printing. This configures the number of ports
assigned to the Windows print queue and allows multiple print jobs to be processed at the same
time.
h) Click OK to save the settings.
I-Queue Printing
I-Queue solves printing challenges by providing a single print queue for every user and every printer.
When submitting a print job you can setup and use the following printing mode options:
• The I-Queue printer for secure printing using a single Follow-You Printing queue where all printers
are combined into a single pull group. The I-Queue holds print jobs sent to the I-Queue printer from
a user workstation. This I-Queue method only supports secure printing and holds print jobs until the
user releases them at a networked printer via Follow-You Printing
• Direct printing via the I-Queue direct printer that enables you to print directly to a printer (without
printer driver installation and authentication or a Follow-You-Printing queue at a printer) in a simple
and straightforward method
To deploy Nuance Unified Client for Toshiba v 1.0 in a single-server or a multi-server Follow-You Printing
environment, do the following:
1. Enable secure printing on each device.
Secure printing sets up a virtual print queue that holds jobs until they are released at the embedded
device by a valid user.
2. Create and manage I-Queue (go to System Manager > Devices, right-click the Devices pane and
select Add I-Queue from the menu and define the settings in the I-Queue summary window).
3. Configure the Follow-You print settings.
Determine the site where you want Follow-You Printing to be accessible from, and choose whether
the print job is priced based on its properties before or after it is released.

447
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Use Follow-You Printing

1. Login at the device: Enter valid login credentials using the on-screen keyboard (invoked by tapping
within the User ID field), or by using a swipe card, or (optional) select the desired Quick Selection
option from the list on the screen, if available.
2. The Launcher screen appears.

Press the Follow-You Printing container from the displayed functions. The Follow-You
Printing screen displays all the queued documents associated with your login credentials or release
key. By default, the list displays documents in order from longest-queued to most-recently queued.
3. Select the job(s) that you want to print and press Print.

Available operations on the Follow-You Printing screen

• Select - or + to adjust the number of copies
• Select the Force B/W switch to force color jobs to print in black and white
• The top line of the documents list indicates the number of documents available. To select or deselect
all documents, press the checkbox next to Print Jobs
• Select or deselect individual print jobs by pressing the print job's respective selection checkbox
• Select Print to release all selected documents

The following options are available by selecting the menu icon at the top right of the screen:
• Select Delete to remove all selected documents from the Job List without printing them
• Select Print & Save to print and save all selected documents from the Job List
• Select Refresh to refresh the current page
• Select About to display the current version of Nuance Unified Client for Toshiba v 1.0
• Select Logout to log out from Nuance Unified Client for Toshiba v 1.0

448
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

AutoStore and Equitrac Deployment Guide

AutoStore and Equitrac Solution Overview
Version 1.0 of the Nuance Unified Client for Toshiba provides a unified client for capture and print
management functionality on specific Toshiba-manufactured Multi-Function Printers (MFPs). When
deployed to the MFP, Nuance Unified Client for Toshiba v 1.0 controls access to the MFP and acts as
the gateway for Nuance functionality.
This document will walk you through a clean installation procedure in AutoStore and Equitrac Office/
Express deployment (file names provided in this document refer to both Equitrac Office and Equitrac
Express - to set up the functionality described in this guide, you can choose to select either - as long as
you are consistent in your choice throughout the process).
Also described is how to set up your first AutoStore capture workflow (Send to Folder) and Equitrac
print workflow (Follow-You Printing) on your Toshiba MFP device. This document will walk you through
a clean installation procedure. Follow the steps provided here to be able to have these workflows
configured on your Toshiba MFP device.

Basic workflow
1. Prepare for deployment
a. Verify that your device is supported
b. Verify prerequisites
c. Get installer packages (AutoStore 7 SP4, Equitrac Office/Express 5.7 with the latest hotfixes,
DRS and Toshiba client package)
2. Install the AutoStore server
3. Install the Equitrac server
4. Configure the Toshiba MFP
a. Install SSL/TLS root certificate
b. Import or create the device certificate on the device
c. Ensure that SSL/TLS is enabled
d. Verify that previous applications are cleared
5. Install and Setup Device Registration Service (DRS)
a. Upload Toshiba Client Package
b. Verify that previous applications are cleared
c. Create application.
d. Add the device
e. Install and register
f. Add and configure your device
6. Create your first capture workflow and verify installation
a. License AutoStore
b. Configure Send to Folder workflow
7. Create your first print workflow and verify installation
a. License Equitrac
b. Configure Follow-You Printing workflow

449
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Prepare for Deployment

Verify that your device is supported
For the latest list of supported Toshiba models, consult your local Toshiba representative or refer
to Nuance Supported Device Search webpage (https://nuanceimaging.custhelp.com/app/imaging/
supported_devices?mfr=164).

Verify prerequisites
DOUBLE-CHECK BEFORE YOU START: Before starting AutoStore and Equitrac deployment ensure
that the following requirements are met. These are targeting a satisfying user experience when you are
doing a single-server installation.
If deploying on separate servers, refer to the individual AutoStore and Equitrac server requirements.
Note: Before installing Equitrac Office/Express and Device Registration Service (DRS) ensure that
the machine you plan to use meets the operating requirements outlined below. Observe that you
MUST have a 64-bit version of operating system.

Note: For Windows Servers 2008, 2008 R2, 2012, 2012 R2 and 2016, make sure the server is up
to date with the latest service packs, or manually download and install the latest version of Windows
Installer from Microsoft. Windows Installer 4.5 is required to install Equitrac 5.7.

Check Description

Verify that the server machine is a member of a domain.

Ensure that the following hardware requirements are met:

• 8 GB of physical memory available
• 5 GB of hard disk space available (including SQL server and prerequisites)
• The CPU is 4 x 2 GHz or greater
32-bit operating systems are not supported.

Ensure that you have Microsoft SQL Server 2008/2008 Express SP3 or later installed.

Check that the operating system is one of the following:

• Windows Server 2016 (x64 with IIS 10.0 and .NET 4.6)
• Windows Server 2012 R2 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2012 (x64 with IIS 8.0 and .NET 4.5)
• Windows Server 2008 (x64 with IIS 7.0 and .NET 4.5)
• Windows Server 2008 R2 (x64 with IIS 7.5 and .NET 4.5)

Verify that you have Administrative access rights to Windows on the server.

Check that all important Windows updates are installed.

Verify that Microsoft Windows Updates is turned ON while you are deploying
AutoStore. This is necessary for the successful installation of Microsoft Windows
Identity Foundation (TFS).

450
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description

Ensure that .NET Framework 3.5 is installed on the server (to verify it, launch Server
Manager > select Local Server > verify that .NET Framework 3.5 is listed under
Roles and Features). If it is missing, it will be installed as part of the AutoStore
installation process.

Ensure that Windows Identity Foundation 3.5 is installed on the server (to verify
it, launch Server Manager > select Local Server > verify that Windows Identity
Foundation 3.5 is listed under Roles and Features).

Allow incoming firewall exceptions for the following ports:

• 80: Device port used for HTTP connections
• 3310: Capture server port
• 443: Device port used for HTTPS connections to the device
• 587: SMTP Email server port used if TLS is enabled
• 2939: SSL is always on for Equitrac and the default port setting of 2939 is not
configurable in DRS
• 8080: Redirects to port 8444 used for HTTPS communication to the DWS
• 8443: Each request to the DWS from the MFP uses the DWS address as specified
in DRS (TLS connections using port 8443). It is these requests and events from the
MFP to DWS that will request the DWS server certificate when completing a TLS
handshake. Also used by Web Administration page
• 8444: Each request to the DWS from the MFP uses the DWS address as specified
in DRS (TLS connections using port 8444). It is these requests and events from the
MFP to DWS that will request the DWS server certificate when completing a TLS
handshake. Also used by Web Administration page
• 8753: The default port for the Device Registration Service Web Service
• 9000: The port used by the server to communicate with the web client. This port is
specified in the Service settings in the DRS Device Configuration Manager
and outgoing firewall exceptions for ports 3310, 8753, 49629, 49630, 50083. (Note
that port 3310 is configurable and you should update your firewall accordingly).

Verify that IE Enhanced Security Configuration is turned OFF for Administrators in IE

Enhanced Security Configuration (to access this, go to Server Manager > Local
Server).

Check that you have all required components downloaded and within easy reach
(components and download locations are listed in the section below).

If you are planning to use any AutoStore Route component that requires client
software, ensure that this software is installed on your server machine before starting
deployment.

Verify that you have Administrative access to the device.

Check that your server(s) and MFP(s) have a DNS A record.

451
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Get installer packages

AutoStore
• AutoStore 7 SP4 or later: Log in to the Web Licensing Portal (https://weblicense.nsius.com/)
and download the executable AutoStore 7 SP4 or later as well as available documentation under
Software Download and Documents > AutoStore 7.
Equitrac
• Equitrac Office/Express 5.7 (build 28.7293) or later with latest hotfixes available for Windows
Server platforms installed: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/) and
download the EO5.7a.zip / EE5.7a.zip file under TECH SUPPORT > Software Downloads
> Equitrac Express or Equitrac Office. Download all available hotfixes under TECH SUPPORT
> Hot Fixes. After that, download Equitrac Office/Express 5.7 related documentation under TECH
SUPPORT.
Additional components
• Device Registration Service: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/)
and download the executable DRS file (9078-DRS7.9Patch2.zip or later) as well as available
documentation under TECH SUPPORT > Software Downloads > Device Registration Service
(DRS) > DRS 7.9 Patch 2 .
• Toshiba Client Package: Log in to the Equitrac Partner Portal (https://partners.equitrac.com/) and
download the ToshibaUC.<version_number>.zip file as well as available documentation under TECH
SUPPORT > Software Downloads > Toshiba Unified Client.
It is recommended to dedicate a folder to all of your downloads for quick and easy access.

Install the AutoStore Server

Once you have verified that all prerequisites are met and all necessary downloads are available,
you can start deploying the package. Start by installing the AutoStore server. Follow the component
installation order described in this document.

Install AutoStore
DOUBLE-CHECK BEFORE YOU START: Before running the AutoStore installer, ensure that you have
the latest system updates on your machine and that Automatic Windows Updates are turned ON.
1. Extract the AutoStore zip file you have downloaded. Inside the folder created during extraction go
into AutoStore installation folder.
2. Select the installation executable file, right-click it and choose Run as administrator.
3. If the installation wizard prompts you to install prerequisite software, click Install.
4. After prerequisite software has been installed, click Next.
5. At this point, you may or may not be prompted to reboot. If you are prompted, reboot your machine.
6. Review and accept the license agreement.
7. On the Customer Information screen, type a user name and organization.
8. On the Custom Setup screen, select all AutoStore components to install. By default, all capture and
process components are selected for installation.
Note: 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.
9. 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.
10.On the Ready to Install the Program screen, click Install.

452
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Install Equitrac
This section provides the steps required to install Equitrac Office/Express on a single machine. A “Local”
installation places all Equitrac Office/Express server components and Administrative Applications on a
single machine. This type of installation is appropriate for small site deployment.
DOUBLE-CHECK BEFORE YOU START: Ensure that you have Microsoft SQL Server 2008/2008
Express SP3 or later installed.

Single machine installation

When installing Equitrac Office/Express, the installation wizard allows you to select the server
components and features to install per machine. For a local installation, install all server components on
the same machine.

Install the Equitrac server

In this document, file names are provided for both Equitrac Office and Equitrac Express. To set up the
functionality described in this guide, you can choose to select either - as long as you are consistent in
your choice throughout the process. .
Once you have verified that all prerequisites are met and all necessary downloads are available, you
can start deploying the package. Complete the following:
1. Close all other applications on the server prior to running the Equitrac Office/Express installation.
2. Unzip the downloaded EO5.7a.zip / EE5.7a.zip file.
3. Select and run the Installer file (Equitrac.Office.exe / Equitrac.Express.exe) to launch
the 64-bit Equitrac Office/Express Installation wizard.
4. Read and accept the terms of the Nuance End User License Agreement, and click Install to
continue.
5. At the Welcome screen, click Next to begin the installation process.
6. On the Select language screen, choose the interface language and select Standard Install.
7. On the Select Features screen, expand Device Control Engine (DCE) and select Device Web
Service (DWS) component and deselect other components.

8. Expand Document Routing Engine (DRE) and select I-Queue component.

9. (optional) Expand and select Scan Processing Engine (SPE) service.

453
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

10.(optional) Expand and select Device Control Service (DCS) if you are to use Ethernet Card
Readers.
11.Click Next.
12.On the Service Log On Credentials screen, enter the account and password (SQL server: admin/
sa) of the user who will run the Windows services. Alternatively, click Browse to search for valid user
from a specific location. Click Test Credentials to verify the user, and click Next to continue.
13.On the Windows Firewall Exceptions screen, select either a manual or automatic setup method
for the firewall exceptions. Click Next.
14.On the Database platform screen, proceed with default selection (SQL Server) and click Next.
15.Select available database server from the Database Instance list, and then click Next. Alternatively,
the database server address, and optionally the instance name, can be typed in the Database
Instance field.
16.On the Database credentials screen, select the authentication type of the selected SQL Server:
• Windows Authentication (default selection): select this option when the user running the
Windows Service account connects to the database server. This user was specified on the
Service Log On Credentials screen
• SQL Authentication: enter the user credentials in the Login and Password fields, (this can be
another Windows user or a SQL Server user)
17.Click Test Connection to check the connection to the database with the selected user, then click
Next.

18.If the specified SQL Express database (“eqcas”) already exists (for example, in the case of an
upgrade), the Database Already Exists screen appears. Select whether to Replace or Keep the
existing database, and click Next.
19.If any of the Web Client features are selected for installation, the Web Client - Application Pool
screens appears. Turn on the Application Pool and test it.
20.On the Web Client - Single Sign-On screen, select the Single Sign-On feature and click Next.
21.On the DCE High Availability Setup screen, do not select the DCE will be part of a High
Availability setup check box. Click Next.
22.On the DCE Local Cache Connection screen, create the Administrator account and Password to
use with Distributed Cache, and click Next.
23.On the Ready to install Equitrac Office/Express screen, click Install.
24.Once installed, click Finish to exit the Equitrac Office/Express Installation wizard.

454
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Install the Equitrac hotfixes

After installing the Equitrac server, install the latest hotfixes you have downloaded from the Partner
Portal (in http://partners.equitrac.com under TECH SUPPORT > Hot Fixes):
• HF-301255-CAS (or later)
• HF-306025-DRE (or later)
• HF-300924-DCE (or later)
• HF-296892-DWS (or later)
• HF-299304-DCS (or later)
• HF-299304-SysMgr (or later)
• HF-288508-WebClient (or later)
Important: The Core Accounting Server (CAS) hotfix must be installed first. After that, proceed in any
order you wish by following the instructions in the hotfix release notes to complete the installation.

Setup the Toshiba MFP

Configure the Toshiba MFP in Nuance Unified Client Environment

BEFORE YOU START

Important: Verify that the device has the correct timezone, date and time set: Navigate to
Administration > Setup > General and check date, time and timezone.

Install SSL/TLS root certificate

TopAccess is a web-based device management tool that allows you to access information about the
Toshiba multifunctional system via the network.
1. Go to C:\Users\eqservice\AppData\Local\Equitrac\Equitrac Platform Component\EQDWSSrv
\webserver\conf\ and copy the dws-root-ca.der file in a location easily accessible to you.
2. Launch a web browser and enter the following URL in the address box: http://<IP Address> or http://
<Device Name> of your MFP. This will open the TopAccess website and let you configure your
device.
3. In TopAccess, navigate to Administration > Security > Certificate Management.
4. Delete any existing CA certificates from the device.
5. Under CA certificate, select CA certificate (DER).
6. Press Choose File.Select the dws-root-ca.der file you have previously copied.
7. Press Upload and save your changes.

Import or create the Device Certificate on the Toshiba device

The Device Certificate must be imported or created on the device to allow the device to trust HTTPS
connections to DWS.
1. For the connection from the Device Web Server (DWS) to the device to work correctly, the device
needs to have a valid certificate that is based on the correct hostname of the device.
a. If the device is set to DHCP the hostname and domain name can be set by the DHCP server.
b. Otherwise, you can manually specify the device’s hostname/fully qualified domain name (that is,
not the IP address) on TopAccess under Administration > Setup > Network.
c. Set hostname first, under Host name.
d. Go to DDNS > Domain Name and set the fully qualified domain name.

455
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Note: The DDNS A record must match this domain name.

2. Navigate to Administration > Security > Certificate Management.

a. Create a self-signed device certificate.
b. Save your changes.
3. Export a self-signed device certificate.
4. Verify date and time and make sure you are in the right time zone by clicking the Details tab.
5. Reboot your MFP.

Ensure SSL/TLS is enabled for ODCA on the Toshiba Device

1. Navigate to TopAccess > Administration > Setup > ODCA.
2. Verify that the SSL port is enabled and that you know the port number. By default, it is 49630.

Ensure that previous applications are cleared

If you had previous solutions configured on the device and these have not been removed properly you
need to clear any existing ODCA Notification Events. In TopAccess, select Administration > Setup >
ODCA > Delete All.
This action should only be performed if previous applications were not properly removed from the
device.

Configure Device Registration Service

Prepare Device Registration Service for use with AutoStore and Equitrac deployment
DOUBLE-CHECK BEFORE YOU START: Administrative access to the server is required. All steps
outlined are performed on the server where the installation takes place.
1. Install DRS: Download and extract the DRS package DeviceRegistrationService.zip. This
creates a new folder containing the installation executable file as well as product documentation.
Select the installation executable file (DeviceRegistrationService.exe), right-click it and
choose Run as administrator. Follow the instructions to install DRS.
2. Upload Toshiba Client Package: Open a web browser and enter http://DRSServerIP:9000/
device (where DRSServerIP is the IP address of the server where you installed DRS) to open the
DRS web client interface. The Nuance Device Registration Service screen opens:

456
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

a) Select the Files tab.

b) From the Device Type drop-down list, select Toshiba Unified Client.
c) At the bottom of the screen, click the Upload button. This opens a file explorer, where you can
navigate to the ToshibaUC.<version_number>.zip and upload. Once upload is complete, the
package appears in the list in the Client Packages column.
3. Create an application in DRS (when adding DWS Server address, use the fully qualified domain
name of the server instead of the IP address):
a) Select the Applications tab.
b) Click the green ( ) button at the top left of the Applications pane.

c) In the Name field (required), enter an application name, for example 'Toshiba'.
d) In the DWS Server Address field (required), enter the Equitrac DWS hostname or the FQDN of
the DWS server.
e) In the Server Configuration list, select AutoStore and Equitrac.
f) In the AutoStore Server Address field (required), enter the IP address used by the AutoStore
Server.
g) In the AutoStore Server Port field, enter the server port used by the AutoStore Server. The
default value is 3310.

457
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

h) In the AutoStore Server use SSL field, select True or False. This setting should reflect your
AutoStore Server configuration. Verify it in the Preference tab of Nuance Unified Client for
Toshiba v 1.0 component. By default, the AutoStore setting "Use SSL" is OFF. If you leave it as
OFF, you should select False in DRS.
i) In the DCE Server Address field (required), enter the IP address used by the Equitrac Server.
Note: DCE and DWS must have the same IP address.

j)
Click the Save button ( ).
4. Add a device in DRS:
a) Click the Devices tab.

b) Click the green ( ) button at the top left of the Devices pane. The Add Device function loads
into the right pane.
c) In the Name field (required), enter a name for the Toshiba device or device group that identifies it
on the network.
d) In the Address field (required), enter the IP address of the device.
e) Enter the Username and Password for the device. By default, the username is admin and the
password is 123456.
f) From the Application drop-down list (required), select the application you created (in this
example 'Toshiba'). The rest of the Add Device fields appear below.
g) In the Port number field (required), set the port number (SSL). The port number needs to match
the port set on the device OCDA setting.
h) In the Client Package field (required), select ToshibaUC_1.0.<build-number>.zip from a list of
uploaded packages.
i) (optional) In case a card reader is attached to the device, enter the Card Reader Product ID (PID)
of a USB card reader in the Card Reader PID field (available via AppBlaster from Toshiba).
j) (optional) In case a card reader is attached to the device, enter the Card Reader Vendor ID (VID)
of a USB card reader in the Card Reader VID field (available via AppBlaster from Toshiba).
Note: Card Readers are only supported in Keyboard Emulation Mode. Use the
Nuance Reader Maintainer Tool available on the Equitrac Partner Portal (https://
partners.equitrac.com/) in the TECH SUPPORT > Software Downloads > Card Readers
section to set it to Keyboard Emulation Mode (the card reader is set in Proprietary Mode by
default).
k)
Click the Save ( ) button at the top of the Add Device pane.
5. Install and register.
a) From the drop-down list at the top of the Details pane, select Install and Register.

458
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

b)
Click the Run Action ( ) button. The installation and registration action may take a few
moments to complete. Once finished, a Successfully completed message appears in the
Action History pane at the bottom of the screen.

Set Up Your First Capture Workflow

At this point in the deployment workflow, you should already have a fully functioning installation. To
verify this, create and configure a very simple capture workflow (Send to Folder) and test it on your
device.

License AutoStore
This is the prerequisite step before you can start configuring your first AutoStore workflow.
1. Launch the AutoStore 7 Process Designer.
2. Go to Home > License Manager > License Request File and save the request as a text (.txt) file to
Desktop.
3. Go to Home > License Manager > Web License.
4. The NSi Web License website (https://weblicense.nsius.com/) opens in a browser. Log in and select
AutoStore 7.
Note: If you are a new user, register your user information. Email addresses from free email
services such as Gmail or Hotmail cannot be used.

5. Go to Downloads > License Activation and select your License Type.

6. Go to Downloads > License Activation > Order and License Request and upload the License
Request file from Desktop.
7. Click Submit once. An activated license file is sent to you by email. Save the received license file
and note the location.
8. In the AutoStore 7 Process Designer go to Home > License Manager > Load License Key File and
select downloaded license file. Click OK to apply the license.
9. Close the AutoStore 7 Process Designer for license to be applied.

Configure Scan to Folder

1. Select the Home tab and choose New.

2. Click OK on the Task Properties dialog and drag the Toshiba Unified Client icon from the left side
of the AutoStore Process Designer Toolbox anywhere on the newly created workflow canvas on
the right side of the screen.

459
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

3. From the Toolbox > Capture icons, click and drag the Nuance Unified Client for Toshiba v 1.0
component to an AutoStore workflow to provide capture functionality for Toshiba devices on which
the Nuance Unified Client for Toshiba v 1.0 is installed.
4. Scroll down to the bottom of the Toolbox list and click and drag Send to Folder to the workflow.

5. Right-click on the Toshiba Unified Client icon and select Properties.

6. Select the Preferences tab. Your settings under Server must match the ones you specified in DRS.
If you kept the default values there, type 3310 in the Web Server Port field, and leave Use SSL
unchecked. Otherwise, ensure that these values match the ones you set in DRS.
7. Select the Groups tab, and click on Common Group for the Toshiba component configuration.
8. Select Add Form > Basic Form. Name the form 'Sample' and click on the Components tab to
configure the folder to route the scan to.
9. Select ... and add the path of the destination folder.
10.Click ... next to Folder path and create a folder such as c:\Scans to send scans to. Check off
Rename file to ensure file names are unique.

11.Click OK.
12.Click Save and save the configuration to a folder such as c:\asconfigs.
13.Click Start at the top of Process Designer. You should now be able to start and use this workflow
from the MFP.
AutoStore has a lot more capture workflows to offer. Consult the downloaded product documentation on
how to set those up.

460
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Set Up Your First Print Workflow

At this point in the deployment workflow, you should already have a fully functioning installation. To
verify this, create and configure a simple print workflow (Follow-You Printing) and test it on your device.

Configure Follow-You Printing

To configure Follow-You Printing settings, do the following:
1. Add MFP device in Windows:
a) Use the Windows Operating System’s Add Printer functionality to create the printer definition to
use a standard TCP/IP printer port (choose Device type, add hostname or IP address, and add
Port name). The first time a user prints to the device, the print queue is created automatically.
b) To register the device in the Equitrac database send a test print to the device.
c) Open Equitrac System Manager, and switch to Devices. Within 30 seconds to a minute after
registering the device, the device appears in System Manager. If you do not see a device, first try
refreshing System Manager.
2. Configure a secure queue:
a) Enable secure printing on each device queue. Go to Equitrac System Manager > Devices >
Standard view > expand the physical device to view the print queue for that printer > click the
print queue link to open the Print queue summary dialog box > enable the Secure printing
option in the Behaviour section.
b) In the Physical Device Summary dialog box, select the Release documents from pull group
option. Type in the name of the Pull group (for example, PullGroupA), then click OK to apply the
change (this will be the virtual queue). You only have to type in the name of the Pull group the first
time you use it. Afterward, it appears in the list automatically.
c) Go to the physical device > Release documents from pull group and add it to the same group
as you have created before.
d) Verify that the virtual and actual physical devices are in the same pull group.
3. Configure Follow-You Printing:
a) In Equitrac System Manager, go to Co > DRE/DRC and Follow-You Printing > Configuration >
Printing.
b) Select the Site where you want Follow-You Printing to be accessible from.
c) In the Settings section, select any of the following options:
• Cost the job before printing – sets the price to a print job based on its properties
• Reprice after release – changes the price of a print job if its properties change after it is
released
• Hide document name in Windows print window – select this option if you do not want
certain documents (such as confidential) from being viewed in the general print queue
• Only print released job while user is logged in to device– if the user logs off prior to
printing the job, the job is put back into the print queue without being released, and the re-
queued print job is not charged to the user
d) In the Space management section, do the following:
• Enter the Job expiry time (this is denoted in hours)
• Enter the Print distribution job expiry time (this is denoted in hours)
e) Select Enabled or Disabled as the global Secure printing default for Follow-You Printing.
f) Select Retrieve username from PJL setting for applications that insert the PJL string into the
print job.
g) In the Number of ports per I-Queue field, enter the number of printer ports (up to 100)
associated with the devices used for I-Queue printing. This configures the number of ports

461
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

assigned to the Windows print queue and allows multiple print jobs to be processed at the same
time.
h) Click OK to save the settings.
I-Queue Printing
I-Queue solves printing challenges by providing a single print queue for every user and every printer.
When submitting a print job you can setup and use the following printing mode options:
• The I-Queue printer for secure printing using a single Follow-You Printing queue where all printers
are combined into a single pull group. The I-Queue holds print jobs sent to the I-Queue printer from
a user workstation. This I-Queue method only supports secure printing and holds print jobs until the
user releases them at a networked printer via Follow-You Printing
• Direct printing via the I-Queue direct printer that enables you to print directly to a printer (without
printer driver installation and authentication or a Follow-You-Printing queue at a printer) in a simple
and straightforward method
To deploy Nuance Unified Client for Toshiba v 1.0 in a single-server or a multi-server Follow-You Printing
environment, do the following:
1. Enable secure printing on each device.
Secure printing sets up a virtual print queue that holds jobs until they are released at the embedded
device by a valid user.
2. Create and manage I-Queue (go to System Manager > Devices, right-click the Devices pane and
select Add I-Queue from the menu and define the settings in the I-Queue summary window).
3. Configure the Follow-You print settings.
Determine the site where you want Follow-You Printing to be accessible from, and choose whether
the print job is priced based on its properties before or after it is released.

Use Follow-You Printing

1. Login at the device: Enter valid login credentials using the on-screen keyboard (invoked by tapping
within the User ID field), or by using a swipe card, or (optional) select the desired Quick Selection
option from the list on the screen, if available.
2. The Launcher screen appears.

Press the Follow-You Printing container from the displayed functions. The Follow-You
Printing screen displays all the queued documents associated with your login credentials or release
key. By default, the list displays documents in order from longest-queued to most-recently queued.
3. Select the job(s) that you want to print and press Print.

462
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Available operations on the Follow-You Printing screen

• Select - or + to adjust the number of copies
• Select the Force B/W switch to force color jobs to print in black and white
• The top line of the documents list indicates the number of documents available. To select or deselect
all documents, press the checkbox next to Print Jobs
• Select or deselect individual print jobs by pressing the print job's respective selection checkbox
• Select Print to release all selected documents

The following options are available by selecting the menu icon at the top right of the screen:
• Select Delete to remove all selected documents from the Job List without printing them
• Select Print & Save to print and save all selected documents from the Job List
• Select Refresh to refresh the current page
• Select About to display the current version of Nuance Unified Client for Toshiba v 1.0
• Select Logout to log out from Nuance Unified Client for Toshiba v 1.0

Reference
This section describes options for the Nuance Unified Client for Toshiba v 1.0 objects.

Device properties for Nuance Unified Client for Toshiba v 1.0

Nuance Unified Client for Toshiba v 1.0 device properties are configured in the Device Registration
Service web console. When configured for a device group, they can be propagated to any device in the
group.

These parameters define the device settings. Click the edit button to edit the parameters for a
device. Click the save button to save changes to the parameters or click the cancel button to
discard changes.

463
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description

Name The name of the Toshiba device or device group

that identifies it on the network.

Address The IP address of the Toshiba device.

Note: This is a device only parameter
and will not be displayed while you are
configuring parameters for a device group.

Inherit Properties from Group This option only appears for a device that is a
member of a device group.
• Click True to use device settings that are
configured for the group. This is the default
setting when you create a new device profile in
a group. The current group settings although
visible cannot be changed. You can only
change group membership defined by the
Device Group setting.
• Click False to configure settings for this device
profile. Choosing this setting allows you to
configure all of the settings for a device. The
default settings after you choose this option
will initially be the same as are configured for
the group, so you only need to change those
settings that you want to be different. Any
changes made to the group settings while this
False will not propagate to the device.

Username The administrator user name for the Toshiba

device. The default is "admin".

Password The administrator password for the Toshiba

device. The default password is "123456".

Application The DRS Application that is associated with the

Toshiba device or device group.

Device Group Click a group name in this box to change group

membership. When a device is a member of a
group it can optionally inherit device settings
defined for the group. This allows you to
simultaneously manage settings for multiple
devices. Select the [Devices] option in this list to
remove a device from group membership.

464
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Port number Set the port number. The port number needs to
match the port set on the device OCDA setting.

Port number (SSL) Set the port number (SSL). The port number
needs to match the port set on the device OCDA
setting.

Client Package Select a client application package from this

list. The selected client application package is
downloaded to a device by the Install action. List
items are populated by the uploaded files specified
on the Files tab. Select ToshibaUC_1.0.build-
number.zip from a list of uploaded packages.

Card Reader PID In case a card reader is attached to the device,

enter the Card Reader Product ID (PID) of a
USB card reader in the Card Reader PID field
(available via AppBlaster from Toshiba).

Card Reader VID In case a card reader is attached to the device,

enter the Card Reader Vendor ID (VID) of a
USB card reader in the Card Reader VID field
(available via AppBlaster from Toshiba).
Note: Card Readers are only supported
in Keyboard Emulation Mode. Use the
Nuance Reader Maintainer Tool available
on the Equitrac Partner Portal (https://
partners.equitrac.com/) in the TECH
SUPPORT > Software Downloads >
Card Readers section to set it to Keyboard
Emulation Mode (the card reader is set in
Proprietary Mode by default).

Nuance Unified Client for Toshiba v 1.0 actions reference

Actions that can be performed from the Device Registration Service for a Nuance Unified Client for
Toshiba v 1.0 device.
To perform an action, first select a device on the Device tab in the Device Registration Service web
console. Then, in the box at the top of the Details pane, click an available action to perform on the

device and click the run button .

465
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Action Description

Install and Register Installs the Nuance Unified Client for Toshiba v
1.0 client application on the MFP or MFD and
registers it with the DWS.
Before you change the Application setting for
previously registered client applications, you
should first run the Uninstall and Deregister
Action before you specify a different Application
for the Device.

Uninstall and Deregister Removes the Nuance Unified Client for Toshiba
v 1.0 client application from the device and
deregisters it from the DWS.

Install Application on Device only Installs the Nuance Unified Client for Toshiba v 1.0
client application on the MFP or MFD.

Uninstall Application from Device only Removes the Nuance Unified Client for Toshiba v
1.0 client application from the MFP or MFD.

Register Device with Server Application only This Action first deregisters the client application
with the DWS if it is already registered. Then it
registers the client application specified from the
Device profile with the DWS.

Deregister Device from Server Application Deregisters the client application from the DWS.
Only

Nuance Unified Client for Toshiba v 1.0 application properties

A Device Registration Service Application profile for the Nuance Unified Client for Toshiba v 1.0
specifies connection information for an AutoStore or Equitrac server. This information allows an MFP or
MFD to use capture and print management services on these servers.
These properties appear in the Device Registration Service Details pane when you add or edit a
Nuance Unified Client for Toshiba v 1.0 application. You cannot change the Application type for an
existing Application.

Property Description

Name A name that uniquely identifies an Application.

Application Type To create a new Nuance Unified Client for Toshiba

v 1.0 application in DRS, choose Toshiba Unified
Client for this option.
The remaining properties shown here appear after
you make this selection. You cannot change the
Application type after you save a new Application
profile.

466
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
DWS Server Address Enter the Equitrac DWS hostname or the FQDN of
the DWS server.

Server configuration Specifies whether this Application will be for

AutoStore, Equitrac, or both:
• AutoStore only
• Equitrac only
• AutoStore and Equitrac

AutoStore Server Address The IP address of an AutoStore server.

AutoStore Server Port The port that the AutoStore server uses to
communicate with the Toshiba Unified Client.
This setting must match the port number that is
set on the Preferences tab of the Toshiba Unified
Client component settings in AutoStore. The
default is 3310.

AutoStore Server use SSL Select True or False. This setting should reflect
your AutoStore Server configuration. Verify it
in the Preference tab of Nuance Unified Client
for Toshiba v 1.0 component. By default, the
AutoStore setting "Use SSL" is OFF. If you leave it
as OFF, you should select False in DRS.

DCE Server Address Enter the IP address used by the Equitrac Server.
Note: DCE and DWS server settings must
have the same IP address.

467
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Nuance Unified Client for

Xerox

Overview of the Nuance Unified Client for Xerox

This section describes options for the Nuance Unified Client for Xerox objects and documents return
and status codes.
The Nuance Unified Client for Xerox is a web-based client that uses a subset of the Xerox Extensible
Interface EIP Application Programming Interface (API) to merge AutoStore scan and Output Manager
print functionality on Xerox MFDs.
The Nuance Unified Client for Xerox consists of a web client and authentication module on the
AutoStore server. A Xerox MFD connects over the network to the web client using HTTP or HTTPS.
The following figure illustrates the architecture for a system that includes the Nuance Unified Client for
Xerox:

Web client
The web client for the Nuance Unified Client for Xerox is a web site hosted by the web server embedded
in either the AutoStore or Output Manager server. The ANT Galio browser navigates to this web

468
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

site based on the URL that was provided during registration. The embedded web server uses the
configuration settings to show and order pages. Business requirements determine if your environment
uses AutoStore or Output Manager. The client provides language interfaces for Danish, Dutch, English,
Finnish, French, German, Italian, Norwegian, Portuguese (Brazilian), Spanish (Latin American), and
Swedish.

Web client
The web client for the Nuance Unified Client for Xerox is a web site hosted by the web server embedded
in either the AutoStore or Output Manager server. The ANT Galio browser navigates to this web
site based on the URL that was provided during registration. The embedded web server uses the
configuration settings to show and order pages. Possible scenarios include configurations where either
AutoStore or Output Manager is present.

Checklist: Nuance Unified Client for Xerox implementation

This implementation check list covers aspects deploying the Nuance Unified Client for Xerox to devices
from the Device Registration Service web client.
This checklist should evolve based on the experience you gain from performing deployments. You might
also want to perform custom checks that are based on a specific aspect of your network architecture or
environment.

Table 11: Unified Client Deployment Checklist

Check Description See

Confirm that your system meets • Requirements on page 470

requirements.

Configure the Xerox EIP • Xerox EIP component help in

component in an AutoStore AutoStore Process Designer.
workflow using the AutoStore
Process Designer.

Add a DRS application for • Add an application

Nuance Unified Client for Xerox. • Nuance Unified Client for
Xerox application properties
on page 482

Add or import a Nuance Unified • Add a device

Client for Xerox device. • Import a device
• Nuance Unified Client for
Xerox device properties on
page 483

Configure a device in Device • Configuring Nuance Unified

Registration Service. Client for Xerox on page
470

469
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Check Description See

Register or unregister • Nuance Unified Client for
client, register or unregister Xerox Actions reference on
accounting, register or unregister page 486
authentication, or restart Nuance
Unified Client for Xerox .

Requirements
The following table describes system requirements for the Nuance Unified Client for Xerox.

Requirement Description
AutoStore The following are required if capture with
AutoStore is enabled in Device Registration
Service.
• Version 7.0 SP1
• Licensed for Xerox EIP capture component
• Task configured with the Xerox EIP capture
component

Equitrac The following is required it print management with

Equitrac is enabled in Device Registration Service.
• Equitrac Office or Express 5.6

Output Manager The following is required it print management with

Output Manager is enabled in Device Registration
Service.
• Build 4.0 SP1
• OM Device configured with:
• Embedded client type set to Xerox
• Unified client option is selected
• OM Destination associated with the OM
Device with the correct printer family definition.
• Destination Group with Pending Queue.
• OM Source Output Setting configured to
Route to the Pending Queue.

Supported devices • Nuance Supported Device Search: Xerox

Configuring Nuance Unified Client for Xerox

Device Registration Service

470
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to configure a Xerox EIP Device in Device Registration Service

Use Device Registration Service to configure a Xerox EIP device to use AutoStore and Output Manager.
1. Enter the Device Registration Service IP address in a web browser to connect to the service.
For example, http://10.16.37.51:9000/device
2. Click Applications.
3. On the Applications toolbar, click Add Application and configure an application profile.
The application profile specifies addresses and ports for the AutoStore, Output Manager, and Device
Registration Service servers. For more information, see Application parameters.
4. On the Add Application toolbar, click Save application.
5. Click Devices.
6. On the Devices toolbar, click Add Device and create a device profile.
For more information, see Device parameters.
7. On the Add Device toolbar, click Add Device.
You can also register authentication and accounting on the devices.
8. Register the Universal Client on the device.
For more information, see actions.
9. Optional: You can click the status button in the Details pane to view registrations on the selected
device. When the device is online, permutations of the following messages show current registrations
for a device:
• Unified Client registered.
• Authentication registered.
• Accounting registered.

Connect to Output Manager

You can configure Output Manager to use HTTP, HTTPS, or Net.TCP to connect to clients. The default
is HTTP. The procedures in this section describe how to change settings to use HTTPS or Net.CFG.
How to use HTTPS to connect to Output Manager
Follow the steps in this procedure to use HTTPS to connect to Output Manager.
1. Browse to the Xerox web.config file (for example, in C:\Program Files (x86)\Notable
Solutions\AutoStore 7\ASXeroxEIPWeb20) and open it in a text editor.
2. Enclose the HTTP section in XML comment tags, which is the default protocol.
These are the <endpoint address="http://DBMSERVER ... /> endpoints near the end of
the <client> element, which is usually at the end of the web.config file.
Tip: Insert <!-- before the first endpoint in the section and --> after the last endpoint in the
section to comment it out.

3. Remove the XML comment tags from the HTTPS section, which are the <endpoint
address="https://DBMSERVER ... /> elements, near the end of the <client> element.
Tip: Add --> to the end of the comment line at the beginning of the section so it appears as <!--
use the following endpoints for HTTPS connections to Output Manager -->.
Remove --> after the last element in the section.
This specifies HTTPS connections to Output Manager, so now there are two ways to connect: HTTP
(default), and HTTPS.

471
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

4. Save the web.config file.

5. Change the URI setting for the Device Registration Service to https://IP_address:8069, where
the IP_address is the IP address for the Output Manager server, and 8069 is the HTTPS port on the
server.
To do this, change the URI section on the Applications tab of the Device Registration Service web
client.
For example, if the default setting is http://10.16.37.56:8068 (where 10.16.37.56 is the IP
address of the Output Manager server and 8068 is the port used for HTTP), then for HTTPS change
it to net.tcp://10.16.37.56:8069 to specify the port for HTTPS.
6. Bind port 8069 to HTTPS connections in the Output Manager server settings.
How to use Net.TCP to connect to Output Manager
Follow the steps in this procedure to use Net.TCP to connect to Output Manager.
1. Browse to the Xerox web.config file (for example, in C:\Program Files (x86)\Notable
Solutions\AutoStore 7\ASXeroxEIPWeb20) and open it in a text editor.
2. Enclose the HTTP section in XML comment tags, which is the default protocol.
These are the <endpoint address="http://DBMSERVER ... /> endpoints near the end of
the <client> element, which is usually at the end of the web.config file.
Tip: Insert <!-- before the first endpoint in the section and --> after the last endpoint in the
section.

3. Remove the XML comment tags from the Net.TCP section, which are the <endpoint
address="net.tcp://DBMSERVER ... /> endpoints, usually the last ones in <client>
element.
Tip: Add --> to the end of the comment line (which starts with that starts with <!-- ) before the
first endpoint in the section, and remove --> from the end of the section.

This specifies Net.TCP connections to Nuance Output Manager, so now there are three ways to
connect: HTTP (default), HTTPS, and Net.TCP.
4. Save the web.config file.
5. Change the URI setting for the Device Registration Service to https://IP_address:8070, where
the IP_address is the IP address for the Nuance Output Manager server, and 8070 is the Net.TCP
port on the server.
To do this, change the URI section on the Applications tab of the Device Registration Service web
client.
For example, if the default setting is http://10.16.37.56:8068 (where 10.16.37.56 is the
IP address of the Nuance Output Manager server and 8068 is the port used for HTTP), then for
Net.TCP change it to net.tcp://10.16.37.56:8070 to specify the port for Net.TCP.

Configuring authentication
The Nuance Unified Client for Xeroxcan provide a Convenience Authentication (CA) service for Xerox
MFDs. This is implemented as a web service hosted by the EWS. It allows for card reader and touch
screen authentication. The credentials obtained are available to the Xerox Unified Client and other
applications running on the device. On MFDs that support the Xerox Job Limits API, functional access
control can also be enforced. This is where a user can be restricted from using features or functions of
the MFD.

472
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

How to register Authentication on VersaLink devices

Use the VersaLink touch screen panel to update device settings.
Before you can register Authentication on a VersaLink device in Device Registration Service, you must
update the device settings for authentication and permissions.
1. At the VersaLink device touch screen, click Permissions > Guest Access > Edit > Device User
Role.
2. In the Control Panel Permissions section, click Everything Except Setup. Click OK.
Do not restart the device when prompted.
3. At the VersaLink device touch screen, click Permissions > Login/Logout Settings > Convenience
> Edit.
4. In the Alternate Login section, click Yes to allow users to log in without their card. Click OK.
5. Restart the device.
Verify that the settings are updated. After you complete this procedure, you can run the Action to
Register Authentication on the device.
Related reference
Nuance Unified Client for Xerox Actions reference on page 486
Actions that can be performed from the Device Registration Service for a Xerox EIP device.

Configuring card reader authentication

The Nuance Unified Client for Xerox component supports card reader authentication.
If the MFD supports card readers, you can configure card reader authentication for the Nuance Unified
Client for Xerox. The primary reader types are proximity card readers and magnetic stripe card readers.
Contact Xerox Support to determine which card readers are compatible with the MFD and if firmware
upgrades are required.
You configure card reader authentication through the Administration application in the Output Manager
Console. Select Set General Preferences and select the Security tab. Select Allow card swipe to
enable the feature. Click Help on the Security tab for more information.
Two-phase authentication requires a personal identification number (PIN) after a card swipe. Enable
two-phase authentication by selecting Require PIN with card swipe on the Security tab in the Output
Manager Console.
Proximity card readers require the user to pass a proximity card to initiate the authentication process.
The event is communicated to the authentication service on the embedded web server along with the
card ID. If a match is found, the authentication service grants access and provides information about the
user such as user name and email address. If a match is not found, the user is given the opportunity to
provide additional authentication data to enable a new proximity card for future use.
Magnetic stripe cards typically contain more information than a proximity card. They store data in
different formats. The Nuance Unified Client for Xerox includes a financial card parser that allows Output
Manager to identify the user or give the user the option to register the card.

Configuring touch screen authentication

A user can authenticate at an MFD device through its touch screen console. The user presses the
button on the top right of the MFD touch screen.

473
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Press Alternate Login to continue the process manually. Depending on the Output Manager settings,
the MFD might prompt the user to log in with a card ID and PIN, or with a user name and password.

Using the Nuance Unified Client for Xerox

474
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Log on to the Nuance Unified Client for Xerox

You can configure AutoStore to allow users to either require or not require users to log in to the Nuance
Unified Client for Xerox. Output Manager always requires user credentials. The AutoStore and Output
Manager documentation describes login requirements. Typically, a user enters the appropriate web
address in a browser and then enters credentials on the login page.

Figure 47: Output Manager login page

Figure 48: AutoStore login page

The initial page view after the user logs in depends on whether Output Manager or AutoStore is the
default application. After the user logs in when Output Manager is the default application, Nuance
Unified Client for Xerox initially shows unprinted documents in table format. See Secure Print page for
additional information.

475
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 49: Initial view for Output Manager secure print

View job properties

This page shows properties for a selected print job.
Access the page by selecting print jobs on the Secure Print page and pressing View Printed Jobs.
Press Done to return to the print jobs list.

Figure 50: Print job properties

See Command buttons for a description of the buttons on this page.

476
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

View or configure job settings

Use this page to adjust print preferences for selected documents.
Access the page by selecting print jobs on the Secure Print page and pressing Settings. Press Done
to save changes and return to the print jobs list. Press Cancel to discard changes and return to the print
jobs list.

See Command buttons for a description of the buttons on this page.

Application navigation

The web client for the Xerox Unified Client is a web site hosted by the web server embedded in either
the AutoStore or Output Manager server. The ANT Galio browser navigates to this web site based
on the URL that was provided during registration. The embedded web server uses the configuration
settings to show and order pages. Possible scenarios include configurations where either AutoStore or
Output Manager is present.

Log on to the Nuance Unified Client for Xerox

You can configure AutoStore to allow users to either require or not require users to log in to the Xerox
Unified Client. Output Manager always requires user credentials. The AutoStore and Output Manager
documentation describes login requirements. Typically, a user enters the appropriate web address in a
browser and then enters credentials on the login page.

477
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 51: Output Manager login page

Figure 52: AutoStore login page

The initial page view after the user logs in depends on whether Output Manager or AutoStore is the
default application. After the user logs in when Output Manager is the default application, Nuance
Unified Client for Xerox initially shows unprinted documents in table format. See Secure Print page for
additional information.

478
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Figure 53: Initial view for Output Manager secure print

Secure Print page

This page first appears after a user logs in to the Xerox Unified Client.
The page initially shows unprinted print jobs for the current user. Press View Printed Jobs to view a list
of released print jobs.

479
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Commands

Button Description

View Printed Jobs Shows a list of printed documents. The documents

are in a retained state and may have an expiration
period as configured by the Output Manager
administrator.

View Job Info Switches to a page that shows more information

about selected documents. Press Done to return
to the documents view.

Print Routes the selected documents to the MFD and

releases them for printing.

Print All Routes and releases all of the unprinted

documents.

Delete Permanently deletes selected documents. The

user can cancel this action.

Settings Adjusts print preferences for the selected

documents. Press Done to return to the
documents view. Any changes are submitted to
Output Manager. Pressing Cancel returns to the
documents view without submitting changes to
Output Manager.

See Command buttons for a description of the buttons on this page.

Properties page
This page shows properties for a selected print job.
Access the page by selecting print jobs on the Secure Print page and pressing View Printed Jobs.
Press Done to return to the print jobs list.

480
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

See Command buttons for a description of the buttons on this page.

Settings page
Use this page to adjust print preferences for selected documents.
Access the page by selecting print jobs on the Secure Print page and pressing Settings. Press Done
to save changes and return to the print jobs list. Press Cancel to discard changes and return to the print
jobs list.

See Command buttons for a description of the buttons on this page.

481
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Reference
This section describes options for the Nuance Unified Client for Xerox objects and documents return
codes.

Nuance Unified Client for Xerox application properties

Nuance Unified Client for Xerox device or device group parameters in the Device Registration Service
device profile. These are configured in the Device Registration Service web console.

The items entered below are applied by clicking the Save application button or canceled by clicking
the Cancel button.
The following options are configurable for a Nuance Unified Client for Xerox application.

Option Description
Name The name of the application.

Application Type The application type is based on the type of

device. For Xerox, select Xerox EIP.

AutoStore Server Address The IP address, computer name, or DNS name

of the machine where the AutoStore Server is
installed. The default is the local IP address.
Important: An entry must be made when
using AutoStore or both AutoStore and
Output Manager.

Print Manager Specifies the print manager to be used with

an application. The following option is current
available for a Nuance Unified Client for Xerox
Application:
• Output Manager

Print Manager Address The IP address of the machine where the print
manager is installed. The default is the local IP
address.
Important: An entry must be made when
using either Equitrac or Output Manager or
when using AutoStore with either Output
Manager or Equitrac.

482
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Print Manager URI The URI for the Print Manager server. the default
has the following format: http://<LOCAL IP
ADDRESS>:8068.
You can specify HTTP, Net.TCP, or HTTPS
protocols. Output Manager settings should be
configured to support the selected protocol.
Important: An entry must be made when
using Output Manager or both AutoStore and
Output Manager.

Web Application Port The port number used by the Web Application.
The default is 3241.
Note: The port number entered here must
match the port number that was used when
configuring AutoStore or Output Manager.
You can use the port number for the following
configuration:
• AutoStore only:
The port number used when configuring the
component with AutoStore Process Designer.
• AutoStore and Output Manager:
The port number used when configuring the
component with AutoStore Process Designer.
• Output Manager only:
The port number used when configuring
Server port on the Clients tab located in
the Set General Preferences settings of the
Administration module of Output Manager.

Use SSL for Web Application Enables secure socket layer (SSL) for the Web
Application. The default is True.

Application Timeout The time after which Notable Solutions Unified

Client will timeout. The default is 60 seconds.

Nuance Unified Client for Xerox device properties

Device properties in the Device DRS application profile. These are configured in the Device Registration
Service.

The items entered below are applied by clicking the Save device button or canceled by clicking the
Cancel button.
The following options are configurable for a Nuance Unified Client for Xerox device or device group for
Xerox EIP.

483
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
Name The name of the Xerox device or device group.

Address The IP address or DNS address of the Xerox

device.
Note: This is a device only parameter
and will not be displayed when configuring
parameters for a device group.

Username The user name for the Xerox device or device

group.

Password The password for the Xerox device or device

group.

Application The name of the Xerox EIP application.

Device Group Click a group name in this box to change group

membership. When a device is a member
of a group in can optionally inherit device
settings defined for the group. This allows you
to simultaneously manage settings for multiple
devices. Select the [Devices] option in this list to
remove a device from group membership and
move it to the root folder in the Devices pane.
This option is not visible while you are configuring
options for a new device.

Application Name The name that will be displayed on the device for
the default application.

Enable Print Release Enables Print Manager print functionality. The

default value is False.

Display destination specific documents only Enables the user to see only printing jobs that are
associated with a specific destination or with a
group of destinations. The default value is False.

Enable Scan Enables AutoStore scan functionality. The default

value is False.

SNMP Specifies the SNMP version to be used with the

client. Choose one of values in the list:
• SNMP V1/V2
• SNMP V3

SNMPv2 GET community name This is the GET community name SNMP
configuration value specified on the device. Enter
either public or private. The default is public.

484
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Option Description
SNMPv2 SET community name This is the SET community name SNMP
configuration value specified on the device. Enter
either public or private. The default is “private.

SNMP Timeout Specify the timeout interval for SNMP requests

by the client in seconds. This is the interval that
the client waits for a response from the agent. The
default value is 5 seconds.
Default Functionality Determines the default functionality for the client.
Options are:
• Output Manager
• AutoStore

SSL Protocol The SSL protocol used by communications with

the server.
• Default
• TLS V1.0
• TLS V1.1
• TLS V1.2

Import properties
Properties that can be included in a CSV import file for a Xerox device.

Header information
The first row in the CSV file is the header row that contains header values for device information.
Header values appear in the following order: Name, IP, ApplicationProfile, DeviceType,
DeviceGroup, Properties, InheritPropertyFromGroup, SerialNumber, Username,
Password. The subsequent rows list the corresponding values for each device separated by commas.
Use the same header row when importing devices for all unified or combined client types.
The first row must always contain the header row, because Device Registration Service uses the
headers to identify imported values. In subsequent rows, you can omit values other than those that
correspond to Name, IP, and ApplicationProfile. If you omit a value, make sure to insert the
comma delimiter that corresponds to the value.

Nuance Unified Client for Xerox import properties

When you select a property, the property name should not include a space in the property name. For
example, Default Functionality should be DefaultFunctionality.
Note: The properties marked with a * are required.

Property Description

ApplicationName (*) The name that appears on the device for the
default application.

485
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Property Description
EnablePrintRelease (*) Enables Output Manager print functionality. The
default value is False.

EnableTrace (*) Enables trace logging. The default value is False.

SNMPGET (*) This is the GET community name SNMP

configuration value specified on the device. Enter
either public or private. The default is public.

SNMPSET (*) This is the SET community name SNMP

configuration value specified on the device. Enter
either public or private. The default is private.

Sample import file

The following example shows Xerox EIP import file entries:

Nuance Unified Client for Xerox Actions reference

Actions that can be performed from the Device Registration Service for a Xerox EIP device.
To perform an Action, first select a device on the Device tab in the Device Registration Service web
console. Then, in the box at the top of the Details pane, click an available Action to perform on the

device and click the run button .

Action Description

Register Unified Client Registers the Notable Solutions Unified Client on

the device.

Register Authentication Registers Authentication on the device.

Before you run this Action on VersaLink
devices, perform the procedure, How to register
Authentication on VersaLink devices on page
473.

Register Accounting Registers Accounting on the device.

Unregister Unified Client Unregisters Notable Solutions Unified Client on

the device.

Unregister Authentication Unregisters Authentication on the device.

486
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Action Description
Unregister Accounting Unregisters Accounting on the device.

Restart Restarts the device.

Command buttons
This page shows the command buttons for some of the properties and settings pages.

Button Name Description

Scan image Switches to the AutoStore

capture component. Output
Manager passes the login
credentials for the current
user to AutoStore. Depending
on AutoStore settings,
AutoStore accepts or rejects the
credentials.

Print Switches to Output Manager.

Logout Ends the Unified Client session

and returns to the login screen.

Exit Closes the Xerox Unified Client

application.

Return codes
Xerox EIP return codes displayed for actions that are performed in the Device Registration Service.

Return Code Description

100 Unified Client is already registered.

101 Unified Client registration succeeded.

102 Accounting registration succeeded.

103 Authentication registration succeeded.

104 Unified Client unregistration succeeded.

105 Accounting unregistration succeeded.

487
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return Code Description

106 Authentication unregistration succeeded.

107 The device is already configured for

authentication.

108 Unified Client, Authentication and Accounting are

not registered.

109 Unified Client and Accounting are not registered,

Authentication is registered.

110 Authentication and Accounting are not registered,

Unified Client is registered.

111 Unified Client and Authentication are not

registered, Accounting is registered.

112 Unified Client and Accounting are registered,

Authentication is not registered.

113 Unified Client and Authentication are registered,

Accounting is not registered.

114 Authentication and Accounting are registered,

Unified Client is not registered.

115 Unified Client, Authentication and Accounting are

registered.

500 Unsupported action.

501 Unable to get device status.

502 Registration failed. Enable Scan, Print or both.

503 Unified Client registration failed.

504 An exception was encountered. Please review the

error log for additional details.

505 Accounting registration failed.

506 Authentication registration failed.

507 Authentication is not registered on this device.

488
Nuance® Device Registration Service EN-DRS-7.11-UG-20171116

Return Code Description

508 Accounting unregistration failed.

509 Authentication unregistration failed.

510 Unable to connect to device.

511 Unable to initialize communications with device.

512 SSL is required for authentication.

Troubleshooting Nuance Unified Client for Xerox

Problem Cause Solution

DRS Xerox Plugin fails This is a VersaLink The workaround for this problem is to
to Register or Unregister firmware issue. reboot the device and then attempt a DRS
authentication on a action such as Register/Unregister/Register
VersaLink B405DN MFP. Accounting/Unregister Accounting/Register
Authentication/Unregister Authentication.

After a document is scanned, This feature is not turned Edit the Xerox web.config file to display
the Scan Completed on by default. the Scan Complete message before
message is not displayed on users complete a scan job.
the console.
1. Make sure that you are logged onto the
AutoStore server as an administrator.
2. Open the Xerox web.config file.
Tip: This file is located
in the C:\Program
Files (x86)\Notable
Solutions\AutoStore
7\ASXeroxEIPWeb20 folder.
3. In the <appSettings> section, add the
following setting:

<add key="monitorJobStatus"
value="True"/>

Note: If the setting is already

included in the web.config file,
change the value to True to enable
the feature. The default value is
False.

489