Device Registration Service User Guide

Version 7.6

Contents
Device Registration Service User Guide...................................................5
Welcome to the Device Registration Service..................................................................................... 5
Using the Device Registration Service............................................................................................... 5
How to open the DRS web client............................................................................................ 5
Working with Applications.........................................................................................................6
Working with Devices............................................................................................................... 7
Working with Device Groups..................................................................................................10
Working with client packages.................................................................................................12
Performing Actions on Devices.............................................................................................. 14
How to manage the DRS service on the server.................................................................... 15
Troubleshooting Device Registration Service................................................................................... 16
Service verification..................................................................................................................18

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

Overview............................................................................................................................................ 20
Implementation Checklist: Nuance Combined Client for Konica Minolta.......................................... 20
Requirements.....................................................................................................................................22
Prepare the MFP to run the Nuance Combined Client for Konica Minolta....................................... 23
Configure Konica Minolta OpenAPI........................................................................................23
Configure MFP Auto Reset Settings...................................................................................... 24
Configure MFP for Print Release........................................................................................... 25
Configuring a device to use the authentication application....................................................25
Configuring the Nuance Combined Client for Konica Minolta...........................................................28
Configure Equitrac.................................................................................................................. 28
Configure Output Manager..................................................................................................... 41
Configure AutoStore............................................................................................................... 52
Configuration Reference......................................................................................................... 54
Using the Nuance Combined Client for Konica Minolta....................................................................63
Nuance Combined Client for Konica Minolta login............................................................... 63
How to switch between capture and print..............................................................................66
How to manage print jobs...................................................................................................... 67
How to configure print settings...............................................................................................70
How to view Print Manager job information........................................................................... 72
How to start an AutoStore workflow.......................................................................................73
Restrictions and Limitations for the Nuance Combined Client for Konica Minolta............................ 75
Troubleshooting................................................................................................................................. 75

Nuance Combined Client for Ricoh.........................................................83

Overview............................................................................................................................................ 83
Checklist: Nuance Combined Client for Ricoh Implementation....................................................... 85
Requirements.....................................................................................................................................85
Configuring the Nuance Combined Client for Ricoh.........................................................................87

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Configure Output Manager..................................................................................................... 87

Configure AutoStore............................................................................................................... 95
Configure Equitrac.................................................................................................................. 95
Configure Nuance Combined Client for Ricoh device properties......................................... 103
Single sign-on integration..................................................................................................... 112
Configuration Reference....................................................................................................... 114
Using the Nuance Combined Client for Ricoh................................................................................ 127
Nuance Combined Client for Ricoh login............................................................................127
Screen layout........................................................................................................................135
Configuration on the device................................................................................................. 136
View Print jobs......................................................................................................................139
View Job information............................................................................................................ 141
Logout................................................................................................................................... 142
Restrictions and limitations..............................................................................................................143
Troubleshooting the Nuance Combined Client for Ricoh................................................................144

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

Overview of the Nuance Unified Client for Ricoh Smart Operation Panel...................................... 146
Checklist: Nuance Unified Client for Ricoh Smart Operation Panel implementation.......................147
Nuance Unified Client for Ricoh Smart Operation Panel system requirements.............................. 148
SOP Device Configuration.............................................................................................................. 150
How to set up the LDAP server........................................................................................... 150
Configuring Nuance Unified Client for Ricoh Smart Operation Panel.............................................152
Configure Output Manager................................................................................................... 152
Configure AutoStore............................................................................................................. 166
Configure Equitrac................................................................................................................ 166
Nuance Unified Client for Ricoh Smart Operation Panel Reference...............................................205
Application properties........................................................................................................... 205
Nuance Unified Client for Ricoh Smart Operation Panel device properties......................... 207
Files tab................................................................................................................................ 211
Nuance Unified Client for Ricoh Smart Operation Panel actions reference......................... 212
Nuance Unified Client for Ricoh Smart Operation Panel Return codes.............................. 214
Action Status Codes............................................................................................................. 215
Troubleshooting the Nuance Unified Client for Ricoh Smart Operation Panel................................215
How to enable Home Key settings.......................................................................................216
Device Config for AuthOff.................................................................................................... 218
How to configure SP Mode settings.....................................................................................219

Nuance Unified Client for Samsung...................................................... 223

Overview.......................................................................................................................................... 223
Checklist: Nuance Unified Client for Samsung implementation...................................................... 223
Requirements...................................................................................................................................224
Reference........................................................................................................................................ 224
Nuance Unified Client for Samsung application properties.................................................. 224
Nuance Unified Client for Samsung device properties.........................................................225
Nuance Unified Client for Samsung actions reference........................................................ 226
Return codes........................................................................................................................ 227
Troubleshooting............................................................................................................................... 228

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Nuance Unified Client for Xerox............................................................ 235

Overview.......................................................................................................................................... 235
Web client............................................................................................................................. 235
Checklist: Nuance Unified Client for Xerox implementation............................................................236
Requirements...................................................................................................................................236
Configuring Nuance Unified Client for Xerox.................................................................................. 237
Device Registration Service................................................................................................. 237
Configuring authentication.................................................................................................... 239
Configuration Reference....................................................................................................... 240
Using the Nuance Unified Client for Xerox.....................................................................................247
Log on to the Nuance Unified Client for Xerox.................................................................... 247
Print jobs...............................................................................................................................248
Delete jobs............................................................................................................................249
View printed jobs.................................................................................................................. 249
View job properties............................................................................................................... 249
Print documents.................................................................................................................... 250
Delete documents................................................................................................................. 250
View or configure job settings.............................................................................................. 250
Switch between AutoStore and Output Manager................................................................. 251
Log out or exit...................................................................................................................... 251
Application navigation......................................................................................................................251
Log on to the Xerox Unified Client.......................................................................................251
Secure Print page.................................................................................................................252
Properties page.................................................................................................................... 254
Settings page........................................................................................................................255

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 AutoStore scan and Output Manager print functionality 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.
2.
3.
4.

Add an Application for a Unified or Combined Client type and configure the Application properties.
Add Devices and configure their properties.
If necessary, add Device groups to organize Devices with the same Application in the groups.
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.

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:
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.

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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. It 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.
How to add an application
This task describes how to add an application 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 not certain about how to do this, see How to open the DRS web client on page 5.
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.
5. In the Application Type box, choose the client type.
Client

Choose

Nuance Combined Client for Konica Minolta

Konica Minolta iOption

Nuance Combined Client for Ricoh

Ricoh ESA

Nuance Unified Client for

Ricoh Smart Operation Panel

Ricoh SOP
Samsung XOA

Nuance Unified Client for Samsung

Xerox EIP Connect

Nuance Unified Client for Xerox

6. Configure settings for the selected device type. Click one of the following topics for details.

Nuance Combined Client for Konica Minolta Application settings

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 Xerox Application settings

7. After you finish configuring settings for the application, click the save button

on the toolbar.

The new application is listed in the Applications pane. You can now refer to it with the Application setting in Device
profiles.
How edit application 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 5.
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 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 Xerox Application settings

6. After you finish making changes, click the

You can click the

button.

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 for a device. After you define a Device profile, you can use it to install the
Nuance imbedded client on the 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,
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 5.
2. On the toolbar, click Devices.
3. On the Devices toolbar, click the add button .

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 Spplication Device type. Refer to one of the following topics for Device configuration details
for a particular client.

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 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 in the Devices pane.
2.
Click the edit button
on the Details toolbar.
3. Edit the device properties as required.
4. Edit settings for the Spplication Device type. Refer to one of the following topics for Device configuration details
for a particular client.

5.

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 Xerox Device settings

Click the save button

on the Details toolbar.

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
clear button

on the Filter toolbar. To clear a filter, click the

.
Entry

Description

Name

The name of the Device group or Device.

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Entry

Description

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 5.
2. Click Devices.
3. Select the
4.
Click the import button
on the Devices toolbar and select the import method:
Click

To
Import Device information from the Output Manager
server.

Import from OM

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.
To import Device information from a CSV file that was
contains previously exported Device information.

Import from file

Browse to the CSV file and click Upload.

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.
5. Close the Import Results window after you review the results of the import.
6. If necessary, edit properties for imported Devices.
For more information, see How to edit a Device on page 8
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 11.

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 8.
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 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 re
achable if the IP address is not valid or the device is currently not visible on the network.
Unified Client Ap
plication Status

Scan GUI Service Status

Status Message

Installed

Installed

Installed; Version: Clien

t: version - Scan GUI Ser
vice: version

Installed

Not installed

Installed; Version: Clien

t: version - Scan GUI Ser
vice: Not installed

Installed

Error

Installed; Version: Clien

t: version - Scan GUI Ser
vice: 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.

10

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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:

Konica Minolta Combined Client Device properties

Ricoh Combined Client Device properties
Ricoh SOP Client Device properties
Samsung Unified Client Device properties
Xerox Unified Client 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.
How to add a new Device 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.
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:

Konica Minolta Combined Client Device properties

Ricoh Combined Client Device properties
Ricoh SOP Client Device properties

11

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Samsung Unified Client Device properties

Xerox Unified Client 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 down loaded 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.
Table 1: Device plug-in folders
*

Device Type

Plug-in folder

Nuance Combined Client for Konica Minolta

NSi.DeviceManagement.Plugins.Konica

Nuance Combined Client for Ricoh

NSi.DeviceManagement.Plugins.Ricoh

Nuance Unified Client for Ricoh Smart Operation Panel

NSi.DeviceManagement.Plugins.RicohSOP

Nuance Unified Client for Samsung

NSi.DeviceManagement.Plugins.Samsung

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 configuration 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.

12

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
Rename

Click this button to rename a selected installation

package file in the list.

Remove Item

Click this button to remove a selected installation

package file from the list.
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.

Upload

How to upload a Unified Client installation package to DRS

This procedure describes how to upload a 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 5.
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.
6. In the Upload dialog box, click Select file, and locate a client file in the package file that you downloaded from
Nuance.

13

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

7. Click Open.
8. Repeat steps 5 on page 13 through 7 on page 14 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
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
device type is selected in the Device Type box.

on

, make sure that the correct

After you complete this procedure, the groups listed here will be listed in the Application Package option in the
device 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 5.
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 14 through step 4 on page 14 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 5.
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 5.
2. Click Devices.
3. Select a Device.
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:

14

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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 5.
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.

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.
This opens the Help button Device Registration Configuration window.
2. Configure settings on the Service, Security, and Administration tabs.

15

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

In the Windows Services console, you can start, stop, pause or resume a service. However, you should always use the
Device Registration Service Configuration Manager to configure the database connection, service settings, security
settings and administration logging, as these features 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
Windows service does not start.

Cause
One or more configuration settings
may be invalid.

Solution
If the Windows service has 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 down.

The Windows service that hosts

the Web service may not have been
started or was unable to start.

Use the Nuance Device

Management Configuration Tool
to ensure that the Web service has
been stated. 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.

Web client reports access is denied.

The user does not belong to the

Access Group set in the Nuance
Device Management Configuration
Tool.

Add the user to the Window group

set with the Access Group field on
the Service tab of the configuration
tool, or clear the Access Group field
to allow all users.

Application does not appear in the

Application drop-down list box whe
n creating a Device.

The application for the specific

device type has not been created.

Create an application in the

Application section of the
Web client. When prompted for
Application Type, select the option
that matches the type of device for
which you want to create a Device.

Importing Devices reports

Imported file is not in CSV format,
Application Profile was not found for or does not follow the expected
all rows.
import format.

16

Verify that the imported file is a text

file in comma separated value (CSV)
format with the .csv extension. If
you are using Microsoft Excel, use

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Description

Cause

Solution
the Save As option to save the file as
a CSV file.
Import headers should appear in the
following order: Name, IP, Appli
cationProfile, DeviceType,
DeviceGroup, Properties, In
heritPropertyFromGroup, S
erialNumber, Username, Pass
word. Refer to the import guidelines
topic in the section for your Unified
Client type for more information.

Web client does not connect to

service when SSL is enabled.

File path to certificate is invalid, or

the password is incorrect.

Use the Nuance Device

Management Configuration Tool
to verify the Certificate Path and
Certificated Password settings on
the Security tab. Ensure that the h
ttpCfg.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 when

SSL is enabled.

File path to certificate is invalid, or

the password is incorrect.

See Web client does not connect to

service when SSL is enabled in this
table for more information.

Web client does not load in the brow

ser.

One or more configuration settings

may be invalid, or the service is not
started.

Use the Nuance Device

Management Configuration Tool
to verify that the Client Port number
set on the Service tab is not in use
elsewhere.

17

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Description

Cause

Solution
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.

Get an Error in Opening Win FIPS was enabled without clearing

dow error message when starting De the SSL settings.
vice Configuration Manager.

Close Device Configuration Manager

and then disable FIPS. Start Device
Configuration Manager, select the
Security tab, clear the Enable SSL
on Web Service and Enable SSL on
Web Client options, and then enable
FIPS.

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

Figure 1: Service Tester dialog box

18

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

19

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Nuance Combined Client for

Konica Minolta Client Guide
Overview
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:

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.

20

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Table 2: Nuance Combined Client for Konica Minolta Checklist

Check

Description
Confirm that your system meets
requirements.

For more information, see

Requirements on page 22

For AutoStore capture functionality,

configure the Konica Minolta iOption
in an AutoStore workflow using the
AutoStore Process Designer.

Konica Minolta iOption

component help in AutoStore
Process Designer.

To use Equitrac as the Print Manager,

configure the Konica Minolta CC
embedded type on the Equitrac

server.

Equitrac Express Administration

Guide
Configure Equitrac on page
28

To use Output Manager as the

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

Output Manager Administration

Guide

Prepare the MFP 1: Configure

Konica Minolta OpenAPI

Configure Konica Minolta

OpenAPI on page 23

Prepare the MFP 2: Configure MFP

auto reset settings

Configure MFP Auto Reset

Settings on page 24

Prepare the MFP 3: Configure the

MFP for print release

Configuring a device to use the

authentication application on
page 25

Prepare the MFP 4: Configure

authentication on the MFP

Configuring a device to use the

authentication application on
page 25

Create a self-signed certificate in

security tab on page 26
How to configure a device to use
SSL for Web Services (OpenAPI)
on page 26
Configure WebDAV to use SSL on
page 27
Configure TCP Socket Setting to
use SSL/TLS on page 27

Configure to use SSL for Web

Services
Configure WebDAV to use SSL
Configure TCP to use SSL/TLS

Add a DRS application for Nuance

Combined Client for Konica Minolta

21

Add an application
Nuance Combined Client for
Konica Minolta application
settings on page 54

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Check

Description
Add or import a Nuance Combined
Client for Konica Minolta device

For more information, see

Register Nuance Combined Client for

Konica Minolta

Add a device
Import a device
Nuance Unified Client for Xerox
actions reference on page 245

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.

Equitrac

Version 7.0 SP1

Licensed for Konica Minolta iOption capture
component
Task configured with the Konica Minolta iOption
capture component

The following is required it print management with

Equitrac is enabled in Device Registration Service.

Output Manager

Equitrac Office or Express 5.6

Configure Konica Minolta CC embedded type

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

Software requirements

OpenAPI ver 2.0 or later

22

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Requirement

Description

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.

4. Configure OpenAPI Settings.

Option

Description
Set this to Allow access to the device.

Access Setting

Port number that the device uses to communicate with

the print server.

Port Number

23

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
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.
Specifies whether the device will be configured to
authenticate users. The default is setting Off.

Authentication

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.

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.

24

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

7. Depending on the Priority Mode setting recorded in step 5 on page 24, change the value for the appropriate
function to 3 minutes:
Priority Mode setting

Change value for this reset:

Copy

Main Menu or 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.
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.

25

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

26

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

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

27

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 >.
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.

28

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 29.
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.

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

29

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

30

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

2. Select one of the following Authentication options from the Input type list box:
Option

Description
Users authenticate with a swipe card.

Card swipe only

Users authenticate with a swipe card or at the MFP

front panel.

Card swipe or keypad entry

Users authenticate at the MFP front panel.

Keypad only

3. Select one of the following options from the Secondary prompt list box:
Option

Description
User must enter a secondary PIN if issued using the
soft keyboard.

Always

User must enter a secondary PIN if they have a PIN 2

value associated with their user account.

If PIN2 available

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.

If PIN2 available or keyboard login

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

31

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
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.

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.

32

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

33

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

4.
5.
6.
7.

Click OK to save the changes.

Navigate to Configuration > Embedded devices.
Select Konica Minolta in the Device type drop-down list.
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.
2.
3.
4.

In Windows, open the Printer window by clicking Start > Devices and Printers.
Right-click the Konica Minolta printer, and then click Properties to open the MFP properties window.
Click the Configure tab, select User Authentication in the Device Option list.
In the Setting list, select Disable.

34

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

Note: The Print without authentication option is used only when tracking print jobs through Equitrac
ports.
4. Press OK to save the setting.

35

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

How to configure card self-registration

When a user swipes an unregistered card, they are required to manually login in order to register the cards 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.

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.

36

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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.
Adds a Search function where users can search for
billing codes.

Search

Displays the Billing code in asterisk characters.

Security mode

37

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description

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. 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.
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.

38

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

39

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.prop
erties

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-S LocalMachine store containing the

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

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.

40

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 device se Use Counter Limit
ttings.
Use Function Limit must be set to True in the device se
ttings.

Use Function Limit

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.
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.

41

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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

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.

42

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 46.
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 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.

43

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 43 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.
2.
3.
4.
5.

In the Device Configuration dialog box, click the Device Details tab.
Select Unified client.
In the Unified Client box, click Configure access control.
Click the appropriate tab to configure access control for Users, Groups, or Departments.
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.
7. Click New to create an MFP ACL profile.

44

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
2.
3.
4.
5.
6.
7.

In the Device Configuration dialog box, click the Device Details tab.
Select the Unified client check box.
In the Unified Client box, click New.
Type a name for the profile in the Name field.
Optional: Type a profile description in the Description field.
Click the arrow next to any item to expand an option group.
Select the check box next to a print option to add it to the Selected items list.

45

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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

46

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

47

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

48

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

9. Click OK.
You do not need to restart the Nuance Combined Client for Konica Minolta. Users see the changes after the 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.

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.

49

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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.

50

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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

51

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

52

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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

53

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Set to
True

Enable Scan

Configuration Reference
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 on the Applications tab of the Device Registration Service
web application.
Option

Description

Name

A name to label the DRS application.

AutoStore Server Address

The IP address, computer name, or DNS name of the

machine that hosts AutoStore Server. The default is
the IP address for the local machine. You must specify
an 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 Manager

Specifies Equitrac or Output Manager as the print manag

er application.

Print Manager Address

The IP address of the machine that hosts the print

manager server. The default is the local IP address.
You must specify an address when Equitrac or Output
Manager is 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 Manager URI

The URI for the print manager server. The default URI is
in the following format:
Equitrac

https://local_IP_
address:port_numbe
r/DwsMain/services

Output Manager

http://local_IP_ad
dress:port_number

You must specify a value when Equitrac or Output

Manager is specified for Print Manager. The default

54

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
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.

Web Application Port

The port number used by the web application. The

default is 3348.
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
a 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 KonicaPanelCli
ent.properties file.
The location for the Koni
caPanelClient.prop
erties is here:
C:\ProgramData\Nua
nce\DeviceControlS

55

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
ervice\Settings\Ko
nicaPanelClient.pr
operties
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 K
onicaPanelClient.
properties file. The
default is 3348. In case
of a conflict with another
application on the server,
you can change the por
t setting in the Konica
PanelClient.prope
rties file to specify an
unused port and configure
the value here to match the
new setting. The location
for the KonicaPanelC
lient.properties is
here:
C:\ProgramData\Nua
nce\DeviceControlS
ervice\Settings\Ko
nicaPanelClient.pr
operties
For more information
about configuring
settings used by the DCS
Service, see Equitrac-only
deployment configuration
on page 39.

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

56

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
on the device panel when a user presses the application
button.

Use SSL for Web Application

Select True to enable the secure socket layer (SSL) for

the web application. The default is False.

Application OpenAPI Port

AutoStore

If this value does not

match the Use SSL
setting specified for the
AutoStore Konica Minolta
iOption component on the
Preferences, a Connec
tion 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 erro
r 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, C
onnection error
appears on the device
panel when a user presses
the application button.

The Konica Minolta OpenAPI port number for the

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

Authority OpenAPI Port

The Konica Minolta OpenAPI port number for the

Authority application. The default is 13353.

57

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
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 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.

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.

58

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description

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.

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.

59

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description
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.

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 Client

After user 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 15.
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

60

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description
codes for Nuance Combined Client for Konica
Minolta devices on page 37.

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 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.

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.

61

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Return Code

Description

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.

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.

62

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Return Code

Description

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.

Using the Nuance Combined Client for Konica Minolta

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

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

63

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

64

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

65

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

66

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

On the print manager screen, click the

button to switch to the capture screen.

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 68

How to manage print jobs for Output Manager Secure Print on page 68

67

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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 70.

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 72.
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.

68

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 70.

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 72.
Switch to the capture screen.
Exit Nuance Combined Client for Konica Minolta.

69

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 70

How to configure print settings for Output Manager Secure Print on page 71

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.
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.

70

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Press

To
Scroll previous options or values.
Scroll next options or values.
Save changes and close print finishing options.

Done

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.

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.

71

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Press

To
Scroll next options or values.
Save changes and close print finishing options.

Done

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 72

How to view job information for Output Manager Secure Print on page 73

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.

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.

72

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

73

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

74

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 37.
Enforcing account limits for scans is not supported.

Troubleshooting

Authentication connection errors on page 75

Unified Client application connection errors on page 76
Unified Client resets too quickly on page 77
Unified client registration error messages on page 77
Authentication registration error messages on page 78
Unified Client unregistration error messages on page 79
Orphan Unified Client button on the device on page 80
Landing page not visible after changing Device Landing Page device setting on page 81
Device panel blocks usage during session on page 81
Incorrect balance displayed for Equitrac copy jobs on page 81

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 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.

75

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

How edit application settings on page 7 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 settings on page 7 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:

How edit application settings on page 7 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 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.

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 settings on page 7 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.

76

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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

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.

Problem description

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 24.

Unified client registration error messages

Code

Message

Comments

502

Unable to proceed. Please The device may be in faulted state

restart device.
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

retry login.

504

Unable to connect to dev

ice. Please restart devi
ce.

505

Maximum registered applic

ations exceeded. Please r

77

Verify that you enter the correct

device admin password in the device
Details pane in Device Registration
Service.

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Code

Message

Comments

emove unused applications

and retry.
506

Device is locked. Please

retry later.

507

Logo icon file does not e Contact Nuance Communications

xist. Contact Nuance Comm Support.
unications Support.

508

Device solution key file Contact Nuance Communications

not found. Contact Nuance Support.
Communications Support.

509

Invalid Output Manager s

erver address. Enter corr
ect server address and re
try.

511

iOption not supported on

device. Add iOption or u
se the Native Scan connec
tor.

512

Invalid password. Enter t Reenter your credentials using a

he valid password and re valid password.
try.

518

Invalid AutoStore server

address. Enter the valid
address and retry.

519

Invalid Web application p The Web Application Port setting

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

Verify that the device is not in

authentication mode or application
mode.

The Output Manager server address

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

The AutoStore server address is

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

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.

78

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Code

Message

Comments

502

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

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

retry login.

504

Unable to connect to dev

ice. Please restart devi
ce.

506

Device is locked. Please

retry later.

Verify that the device is not in

authentication mode or application
mode.

509

Invalid Output Manager s

erver address. Enter corr
ect server address and re
try.

The Output Manager server

address is blank. Either enter the
Output Manager server address
on Applications tab of DRS or
set Enable Print Release as False
on Devices tab of the Device
Registration Service.

Konica Minolta iOption: A

n error occurred when ini
tializing web application
. Failed to listen on pre
fix 'https://+:port/' be
cause it conflicts with a
n existing registration o
n the machine.

AutoStore and Equitrac are installed

on the same machine and Equitrac
is configured to use the same port
as AutoStore. The default for both
applications is 3348. To correct this
problem, you must change the port
used by Equitrac. To do this, edit the
port setting in the KonicaPane
lClient.properties file. The
location for the KonicaPanelCli
ent.properties is here:

Verify that you enter the correct

device administrator password.

C:\ProgramData\Nuance\Dev
iceControlService\Setting
s\KonicaPanelClient.prope
rties
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.

79

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Code

Message

Comments

502

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

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

retry login.

504

Unable to connect to dev

ice. Please restart devi
ce.

506

Device is locked. Please

retry later.

513

Unregistration failed bec There is no registered Unified Client

ause no unified client ha application.
s been registered.

Verify that you enter the correct

device administrator password.

Verify that the device is not in

authentication mode or application
mode.

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.

80

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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

The balance displayed on the device panel is insufficient
for copy jobs even when the balance is still sufficient for
copy jobs.

Problem description

Equitrac 5.6 does not provide cost information to the

Combined Client for Konica Minolta. It only provides
the number of black and white and the number of color
pages allowed. The number of color pages is subject to
two limitations

Cause

81

The cost of each page when compared against the

balance.

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
Log out and then back in to get an updated balance.

Solution

82

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Nuance Combined Client for

Ricoh
Overview
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:

83

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 FollowYou 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.

84

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
Table 3: Ricoh Combined Client Checklist
Check

Description

See

Confirm that your system meets requirements.

Requirements on page 85

For AutoStore capture functionality, add and configure the

Ricoh ESA component in an AutoStore workflow using the
AutoStore Process Designer.

Ricoh ESA component help in AutoStore

Process Designer.

To use Equitrac as the Print Manager, configure the Ricoh

CC embedded type on the Equitrac server.

Equitrac Express Administration Guide

To use Output Manager as the Print Manager, configure the

Ricoh embedded device type in Output Manager.

Output Manager Administration Guide

Add a DRS application for Nuance Combined Client for

Ricoh.

Add an application
Nuance Combined Client for Ricoh
application properties on page 114

Add or import a Nuance Combined Client for Ricoh

device.

Add a device
Import a device
Nuance Combined Client for Ricoh
device properties on page 115

Setup, uninstall, configure, or reboot a Nuance Combined

Client for Ricoh device.

Nuance Combined Client for Ricoh

actions reference on page 123

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.

85

Version 7.0 SP1 or later

Licensed for Ricoh ESA capture component
Workflow configured with the Ricoh ESA capture
component

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Component

Requirement

Equitrac

The following is required if print management with

Equitrac is enabled in Device Registration Service.

Output Manager

Equitrac Office or Express 5.6

Configure Ricoh CC embedded type

The following is required it print management with

Output Manager is enabled in Device Registration
Service.

Java

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.

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.
Languages

The Nuance Combined Client for Ricoh provides

localization support for the following languages:

86

Spanish (Latin American)

German
Italian
Dutch
Danish
Swedish
French
Portuguese (Brazilian)
Norwegian
Finnish

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Component

Requirement

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:

Supported devices

CAC Authentication application is set to have first

priority.
Device heap stack is set to a minimum of 45 MB.

Nuance Supported Device Search: Ricoh

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.

87

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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 104.
b) Enable Output Manager login for Nuance Combined Client for Ricoh.
See How to configure sign-in methods on page 90.
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.

88

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
2.
3.
4.
5.

In the Device Configuration dialog box, click the Device Details tab.
Select Unified client.
In the Unified Client box, click Configure access control.
Click the appropriate tab to configure access control for Users, Groups, or Departments.
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.
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.

89

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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.

90

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
7. Restart Output Manager.

91

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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:

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.

92

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

93

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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:

94

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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

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.

95

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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 96.
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.

96

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.
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.

97

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

2. Select one of the following Authentication options from the Input type list box:
Option

Description
Users authenticate with a swipe card.

Card swipe only

Users authenticate with a swipe card or at the MFP

front panel.

Card swipe or keypad entry

Users authenticate at the MFP front panel.

Keypad only

98

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

3. Select one of the following options from the Secondary prompt list box:
Option

Description
User must enter a secondary PIN if issued using the
soft keyboard.

Always

User must enter a secondary PIN if they have a PIN 2

value associated with their user account.

If PIN2 available

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.

If PIN2 available or keyboard login

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 cards 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.

99

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

100

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
Adds a Search function where users can search for
billing codes.

Search
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.

101

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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:
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.

102

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 6 and Working with Devices on page 7
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 .
2. Unzip the 33956099.zip file located in the DRS installation directory (for example, C:\Program Files (x8
6)\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>

103

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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\Plug
ins\). How to add a new Device profile on page 7 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.

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.

104

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

This displays the SP mode options screen.

3. Press System Sp.

The SP mode service options appear.

4.
5.
6.
7.
8.

Press SP-5XXX and page down until 5113 appears.

Press 5113 > 2 to show the COPY : SP-5-113-002 page.
Press 1: Expansion Device 1 > OK.
Press Exit.
Restart the device.

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:

105

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

2. Press System Sp.

The SP mode service options appear.

106

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

3. Scroll down and press the 5401 button.

4. Press 103, enter 3, and press # to save the setting.

5. Press 230, enter 0, and press # to save the setting.

6. Press Exit to exit SP mode.

107

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

7. Restart the MFD.

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.

108

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

109

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

110

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

111

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

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 parameters
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.

112

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

113

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

Configuration Reference
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.

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.

114

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description
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

Nuance Combined Client for Ricoh device properties

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
save

button to edit the parameters for a device. Click the

button to save changes to the parameters or click the cancel

Option

button to discard changes.

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.

115

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description

Inherit Properties from Group

This option only appears for a device that is a member of

a device group.

Username

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.

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.

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.

116

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description

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.

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 l

ogging.
Smart Operation Panel Compatibility Mode

Enables authentication compatibility between the

Nuance Combined Client for Ricoh and Ricoh devices
that have a Smart Operation Panel.

117

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
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 manage

r 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.

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

118

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
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.

Authentication Algorithm

Specifies the cryptographic hash function used to protect

authentication information.

Encryption Algorithm

SHA1
MD5

Specifies the encryption algorithm used to encrypt

communications with a device.

AES
AES192
AES256
DES

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.

119

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Mode

Description

Print Manager Authentication with Device Access

Control

The print manager server manages authentication. 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.

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.

120

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Mode

Description
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.

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 thirdparty 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.

121

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Mode

Description
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.
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

Xlet is not installed.

100

Xlet is installed.

200

Xlet is initializing.

300

Xlet has started.

350

Xlet has stopped.

122

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Return Code

Description

370

Xlet has paused.

390

Xlet is inactive.

500

Xlet status cannot be determined.

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, Pro
perties, InheritPropertyFromGroup, SerialNumber, Username, Password. The subsequent

123

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 Appli
cationProfile. 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:

Authentication (*)

Print Manager
AutoStore

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.
SecureCommunication

Set to True to enable secure socket layer (SSL)

communication through HTTPS. Set to False to use

124

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description
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.

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.

125

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description

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.

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:
Name,IP,ApplicationProfile,DeviceType,DeviceGroup,Properties,InheritProperty
FromGroup,SerialNumber,Username,Password
Ricoh,191.211.13.5,Ricoh Profile,RicohESA,Ricoh Group,EnablePrintRelease=tru
e~EnableScan=true,TRUE,E153M310024,admin,ricoh
Ricoh,191.211.13.9,Ricoh Profile,RicohESA,Ricoh Group,EnablePrintRelease=tru
e~EnableScan=true,TRUE,E264M302574,admin,ricoh

126

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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

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.

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).

The External client login The settings define three login methods and two PIN options:

127

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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

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

128

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

Figure 16: Soft keyboard

When the Allow unmasked card ID check box is cleared, the entry is obscured as the user types characters.

129

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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:

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

130

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.
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.

131

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

132

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Equitrac login
This section shows Equitrac login screens for the Nuance Combined Client for Ricoh.

Figure 18: Equitrac card swipe

133

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Figure 19: Equitrac card ID and PIN

Figure 20: Equitrac login swipe with domain credentials

134

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 7.

Figure 22: AutoStore screen

135

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

136

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

137

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Operation

Description

Done

Closes the preferences for the jobs on the Print Manager

server.

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.

138

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Figure 27: Output Manager default billing accounts

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.

139

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Figure 29: Output Manager "Release my print" jobs list

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.

140

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Button

Description

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.

Figure 31: Job Information screen

141

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

142

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

Restrictions and limitations

Short reference description.
Restriction or limitation
Limited tracking of job attributes

Category
Equitrac reporting

Comments
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 unspec

ified

Equitrac reporting

If page sizes are included for

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 l

imited to 10,000.

Scan workflows not available

Equitrac

Equitrac scan workflows are not ava

ilable.

No external application support

Equitrac

143

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Restriction or limitation

Category

No guest user support

Equitrac

No release key support

Equitrac

Cannot use page size limits

Equitrac

Comments

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:

J522

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.

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.

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:

144

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

1. Locate the 33956099.zip file on the server (for example, C:\Program Files (x86)\Nuance\Device R
egistration 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.

145

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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:

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.

146

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
Table 5: Unified Client Deployment Checklist
Check

Description

See

Confirm that your system meets requirements.

Nuance Unified Client for Ricoh Smart

Operation Panel system requirements
on page 148

For AutoStore capture functionality, configure the Ricoh

SOP in an AutoStore workflow using the AutoStore Process
Designer.

Ricoh SOP component help in

AutoStore Process Designer.

To use Equitrac as the Print Manager, configure the Ricoh

PCC5 embedded type on the Equitrac server.

Equitrac Express Administration Guide

To use Output Manager as the Print Manager, configure the

Ricoh SOP embedded device type in Output Manager.

Output Manager Administration Guide

If a required Unified Client installation package is not

already in DRS, download the client installation package

from the Equitrac Partner Portal or from the Web Licensing
Portal and add it to the DRS server.

Working with client packages on page

12
How to upload a Unified Client
installation package to DRS on page 13

Add a DRS application for Nuance Unified Client for Ricoh

Smart Operation Panel.

Add an application
Application properties on page 205

Add or import a Nuance Unified Client for Ricoh Smart

Operation Panel device.

Add a device
Import a device

147

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Check

Description

See

(required) Configure Service Program Modes.

Nuance Unified Client for Ricoh Smart

Operation Panel device properties on
page 207

How to configure SP Mode settings on

page 219

(optional) Perform these additional steps to use the Auth Of

f client on the MFP.

Device Config for AuthOff on page

218

(optional) Enable Home Key settings.

How to enable Home Key settings on

page 216

Install, uninstall, configure, or restart Nuance Unified Client

for Ricoh Smart Operation Panel.

Nuance Unified Client for Ricoh Smart

Operation Panel actions reference on
page 212

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 Manager

The following is required it print management with

Output Manager is enabled in Device Registration
Service.

Languages

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.

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

148

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Component

Requirement
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. The following
card readers have been tested with this Unified Client:

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.

149

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Component

Requirement

CAC Authentication

To run the Nuance Unified Client for Ricoh Smart

Operation Panel with the CAC solution, ensure
compliance with the following before installing the
Nuance Unified Client for Ricoh Smart Operation Panel:

Supported devices

CAC Authentication application is set to have first

priority.
Device heap stack is set to a minimum of 45 MB.

Nuance Supported Device Search: Ricoh

SOP Device Configuration

How to set up the LDAP server
This procedure describes how to set up the LDAP server when configuring SP Direct modes.
1. Navigate to User Tools > Machine Features > System Settings > Administrator Tools > Program/Change/
Delete LDAP Server.

2. Click Program/Change, and then enter the server details.

3. Press the Next button and enter authentication settings.

150

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

4. Click the Connection Test to confirm the configuration.

You will see the following result if successful.

5. Press the Next button to complete settings on the succeeding pages.

151

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

152

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.
2.
3.
4.
5.

In the Device Configuration dialog box, click the Device Details tab.
Select Unified client.
In the Unified Client box, click Configure access control.
Click the appropriate tab to configure access control for Users, Groups, or Departments.
Click the browse button (...) for the user, group, or department that you want to configure.

153

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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.
2.
3.
4.
5.
6.
7.

In the Device Configuration dialog box, click the Device Details tab.
Select Unified client.
In the Unified Client box, click New.
Type a name for the profile in the Name field.
Optional: Type a profile description in the Description field.
Click the arrow next to any item to expand an option group.
Select the check box next to a print option to add it to the Selected items list.

154

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

8. Click OK.
If the Nuance Unified Client for Ricoh Smart Operation Panel 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.

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

155

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

156

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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

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.

157

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

158

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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:

159

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 155

Set manageLogin to external

Login settings on page 160

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.
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).

160

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

161

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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:

162

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

163

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 7.

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.

Copies

Changes the number of copies of a document to print.

164

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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

165

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

in Device Registration Service (for more information, see Nuance Unified Client for Ricoh Smart Operation Panel
device properties on page 207).
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
Configure the authentication for the Nuance Unified Client for Ricoh Smart Operation Panel component to work with
Equitrac authentication.
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).

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.

166

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 SelfRegistration 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 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 serversone

primary, and up to three backup servers. We recommend
that the primary DCE is located on-site to allow for the

167

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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
You must have administrative access to both the MFP and to the network computer hosting the Equitrac server
components to install and configure Nuance Unified Client for Ricoh Smart Operation Panel. Note the administrative
credentials for the MFP differ from those of the Windows network credentials with assigned administrative rights.
Your Ricoh technician will provide the default administrative credentials for the MFP.
Before you begin the installation:

Ensure the Smart Operation Panel in use is Generation 2 or later.

Ensure you have met the requirements for your multifunction printers (MFPs) and Equitrac Office or Equitrac
Express installation. See Nuance Unified Client for Ricoh Smart Operation Panel system requirements on page
148 for more information.
Install or update, license, and configure Equitrac Office or Equitrac Express 5.6 or higher before installing Nuance
Unified Client for Ricoh Smart Operation Panel. For more information, see your Equitrac Office or Equitrac
Express documentation.
Ensure that the Equitrac Office or Equitrac Express hotfixes are installed on the server.
Download the appropriate Nuance Unified Client for Ricoh Smart Operation Panel installation files for your
device and copy them to a shared network location. The DRS will use the files during installation.
Obtain the IP address for the Equitrac Office or Equitrac Express Device Control Engine (DCE) server(s).
Obtain the IP address of the Ricoh devices where you will install the Nuance Unified Client for Ricoh Smart
Operation Panel.

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
Equitrac Standalone
(PCC 5)
AutoStore
Standalone (no
device locking)

EO/EE

AutoStore

Yes

Output Manager

Authenication
Agent
Yes

Yes

No

168

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Scenario

EO/EE

AutoStore

Output Manager

Authenication
Agent

Output Manager
(with device locking)

Yes

Yes

Output Manager (no

device locking)

Yes

No

Equitrac + AutoStore Yes

Yes

Yes

Output Manager
+ AutoStore (with
device locking)

Yes

Yes

Yes

Output Manager +
AutoStore (no device
locking)

Yes

Yes

No

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.
Guide

When to refer to this guide

Equitrac Office /Express Planning Guide

Before installing Equitrac Office or Express, use this gui

de to select the appropriate combination of product varia
bles to support the needs of your institution or organizati
on.

Equitrac Office Installation Guide Equitrac Express Insta Use this guide to perform an initial installation or upgrad
llation Guide
e.
Equitrac Office Administration Guide Equitrac 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 User Guide (Add an Applica Use this online help guide to determine installation, unins
tion section)
tallation and upgrade processes.
Installation Workflow
To install and configure the SOP and its server components, you must have administrative access to the machine
hosting the Equitrac server components. Default administrative credentials for the MFP are provided by your MFP
technician; server credentials by your network administrator.
Follow this workflow to install Nuance Unified Client for Ricoh Smart Operation Panel per device:
1. Download the current Nuance Unified Client for Ricoh Smart Operation Panel zip files from the Equitrac Partner
Portal. Do not extract the contents of the zip files.
2. Complete the preparation steps described in Prerequisites - Before You Install.

169

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
3. Establish communication with the Equitrac server: ensure that the device is logically networked to the Equitrac
server, and that you have administrative access to the server.
4. License and configure Nuance Unified Client for Ricoh Smart Operation Panel in System Manager.
Preparing the MFP
Caution: Any MFP-specific settings must first be configured by your Ricoh administrator. See System
configuration settings for more information.
Before you use DRS to install the Nuance Unified Client for Ricoh Smart Operation Panel embedded solution,
complete the following steps to prepare the MFP for installation:
1.
2.
3.
4.
5.

On the Ricoh Smart Operation Panel home screen for the device, select the User Tools option.
From the menu, select Machine Features. The Machine Features screen displays.
From this screen, Log in with Administrator privileges.
Select System Settings, then select the Admin Tools Tab.
Locate the Administrator Authentication Management button and press it. The Administrator Authentication
management options open.
Note: You may need to page down to locate this option.

6. Ensure the Admin. Authentication option is set to On. Then press OK.
7. Navigate to User Tools > Machine Features > System Settings > Administrator Tools > User Authentication
Management.
8. Ensure LDAP Authentication is enabled.
Note: The label LDAP authentication will be changed to 'Custom authentication' after machine
rebooted.
9. Navigate to the Custom authentication tab, select None for copier function.
10. Still on the Custom Authentication tab, deselect Scanner and Fax, and then press OK.
11. Navigate back to System Settings, then open the Machine action when limit is reached option.
12. Enable either Stop Job or Finish Job and Limit, then press OK.
13. Navigate to User Tools > Screen Features > Interface Settings.
14. Ensure Machine Network is selected.
15. Reboot the MFP.
After reboot, set the card reader auto-wakeup by accessing the administrator settings of the machine and navigating to
Service > Screen Features > Screen Device Settings > Screen device always-connection Setting. Ensure Auth On
is Active.
Note: 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.
USB 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

170

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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
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 reader

13AD

9CA9

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
Many Ricoh devices have more than one available USB port. Typically, Equitrac card readers occupy the USB port
located to the left of the SOP Panel.

Note: Alternatively, the mini-DIN slot underneath the SOP Panel can be used to connect a card reader using
an adapter cable. To connect a card reader in this way, contact your Ricoh service representative.

171

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Third party card readers can use either the ports described above, or any other USB port on the SOP. 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.
Paper type setup
The correct paper type must be set to allow for accurate tracking of copies. 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.

Note: The Web Image Monitor page may differ in appearance and location of functions by device. The
basic functionality remains the same.
3.
4.
5.
6.
7.

Navigate to Device Management > Configuration. The Configuration options display.

Under Device Settings, click Paper. The Paper options display.
Under Tray 1, from the Paper Weight drop-down list, select any of the Plain Paper options.
If you are using the Bypass Tray, ensure it is also using this setting.
Click OK.

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.
1. Open System Manager by selecting Start > All Programs > Equitrac Office/Express > System Manager.

172

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

173

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 licenseunless 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.
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)

174

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

3. Enter a Name and Description for the embedded device.

175

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 users 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 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.

176

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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 users 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:

177

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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. 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:

178

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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 devices 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:

179

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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, systemmanaged 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.

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 attributes
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.

180

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 > Configuration > This timeout applies to all software
Devices > Embedded Devices
functions, such as login, Scan-ToMe and Follow-You Printing. When
Note: The default value
this timeout expires, the user is
is 60 seconds, and must be
immediately logged out.
set to at least 30 seconds 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. Cannot be If a user fails to log out when

modified.
finished using the device, logout
occurs after this time.

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

181

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

182

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

183

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 serverseach of which manages a
separate set of devicesyou 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 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 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.
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

184

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 users 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.
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.

185

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

3. Under Settings, enable the following options if necessary:

Option

Description

Enable advanced settings

When enabled, adds a manual configuration menu to th

e system, including Scan settings, Auto density, Feed
type, and Filename/type to the SOP Scan-to-Me scree
n on the MFP. Users can click on the menu items to ch
ange scan settings.

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 scr

een 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 mail
box. If the To field is empty, then the users email addr
ess is automatically put back into the To field.

Enable CC field

When enabled, adds the Cc field to the SOP Scan-to-M

e screen on the MFP, allowing users to enter one or mo
re email addresses. The scan is sent to users in the Cc li
st, 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.

186

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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....

2. Enter your SMTP Email server which is either the servers 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:

187

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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 optionsafter 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.

188

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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.

189

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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

At end of session
Do not display

Session cost

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

190

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 users 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).

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:

191

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

192

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 'multi-page 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 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.

193

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

194

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 credentialsnetwork 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.
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 dont 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

195

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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.

196

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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:

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.

197

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 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.
File Name: The desired name of the scanned file. This typically auto-populates with system information.

198

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 199 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

O
CR

PDF (Image)

Basic PDF - Not searchable.

MFPs 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 MR Searchable PDF with additional compression. Useful for black and white documents w #
C
ith a large amount of text.
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) - Tru

e Page

Native Word - 2000 to 2003 - Matches most closely with the scanned text, but is more
difficult to edit.

Word (.doc) - Flow Word 2000 to 2003 - Uses Word formatting to simplify editing, but does not match as c #
ing Page
losely to the original.

199

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Format

Description

O
CR

Word (.docx) - Tr
ue Page

Word 2007 and 2010 - Matches most closely with the scanned text, but is more difficu
lt to edit.

Word (.docx) - Flo Word 2007 and 2010 - Uses Word formatting to simplify editing, but does not match a
wing Page
s closely to the original.

Excel (.xls)

Excel 2000 to 2003.

Excel (.xlsx)

Excel 2007 to 2010.

Searchable XPS

Searchable XPS (Microsofts 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:
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:

200

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
Logging Out of Nuance Unified Client for Ricoh Smart Operation Panel
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.
After viewing the Session summary, click OK to close it and log out of the Unified Client for Ricoh SOP. If you do
nothing, the screen will auto-dismiss after the system times out.

Note: Logging out mid-scan cancels any active scan session and then logs out. Any documents in the ADF
will continue to scan until finished. One complete, no scans are processed.
Manual Settings
Some device settings must be manually configured at the device in order for Nuance Unified Client for Ricoh Smart
Operation Panel to operate correctly. This section describes required settings.
Warning: The settings in this section can only be modified by qualified Ricoh technicians. Please contact
your Ricoh support representative for assistance.
Note: After you change settings documented here, you must reboot the device to implement the changes.
Minimum Firmware
The minimum firmware by component is listed below.
Component
M2A_System

Firmware Version
1.07.0.4

Notes
Production version will be relabeled
as 1.09

201

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Component
System/Copy

Firmware Version

Notes

D1965406E.pkg

Device notes
Rarely, you may want to perform maintenance or actions to the device or software. This section provides some
general notes.
This section also provides specific system-level configuration settings.
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.
Finalize the Uninstallation
Uninstallation of Nuance Unified Client for Ricoh Smart Operation Panel is handled through DRS. Please see the
uninstallation instructions in the Device Registration Service User Guide for instructions.
When the uninstallation is complete, the Nuance Launcher icon remains on the Ricoh Smart Operation Panel Home
screen. To remove it, do the following:
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 devices 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 devices 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.
Note: Once the screen shuts down, the devices 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.

202

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Depending upon the devices 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.
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

Auth Off

Notes

Service > Screen Features Either

> Screen Device Settings
> Home key settings >
Home key application

Either

Needed for card reader

auto-wakeup

Service > Screen Features Active

> Screen Device Settings
> Screen device alwaysconnection Setting

Either

Needed for card reader

auto-wakeup

User Tools > Machine

Features > System
Settings > Administrator
Tools > Administrator
Authentication
Management > Admin.
Authentication

On

On

User Tools > Machine

Features > System
Settings > Administrator
Tools > Administrator
Authentication
Management >Available
Settings

Administrator Tools

Administrator Tools

User Tools > Machine

On
Features > System
Settings > Administrator
Tools > Auto Delete User
in Address Book

Off

User Tools > Machine

On
Features > System
Settings > Administrator
Tools > Enhanced Print
Volume Use Limitation >
Stop Printing

Off

User Tools > Machine

Features > System
Settings > Administrator
Tools > Enhanced Print

Off

On

203

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Configuration Path

Auth On

Auth Off

Notes

Volume Use Limitation >

Tracking Permission
User Tools > Machine
Features > System
Settings > Administrator
Tools > Machine action
when limit is reached

Stop Job

Allow Continue Use

User Tools >

Machine Features >
System Settings >
Administrator Tools >
User Authentication
Management > Custom
Auth > Available
Functions Copier

None

Custom as configured

User Tools >

Machine Features >
System Settings >
Administrator Tools >
User Authentication
Management > Custom
Auth > LDAP Servers

Not Programmed

N/A

User Tools >

Machine Features >
System Settings >
Administrator Tools >
User Authentication
Management > Custom
Auth > Other Functions

None

Custom as configured

User Tools >

Machine Features >
System Settings >
Administrator Tools >
User Authentication
Management > Custom
Auth > Printer Job
authentication

Entire

Entire

User Tools >

Machine Features >
System Settings >
Administrator Tools >
User Authentication
Management > OFF

N/A

Off

204

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Configuration Path
User Tools > Screen
Features > Interface
Settings

Auth On

Auth Off

Machine Network

Machine Network

Notes

System SP Modes
Note the following SP modes must be set regardless of the device:

SP Setting: System SP5-401-230

Value: 00000001

Nuance Unified Client for Ricoh Smart Operation Panel Reference

These sections describes how to configure a Ricoh SOP device.

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.

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.

205

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description

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.

Print Manager Server Address

None
Equitrac
Output Manager

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.

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.

206

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Property

Description
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.

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
save

button to edit the parameters for a device. Click the

button to save changes to the parameters or click the cancel

Option

button to discard changes.

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.

Username

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.

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.

207

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description

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.

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).
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.

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 to match the Smart Operation Panel type to be

supported by this device configuration.

208

C306/406 for A4 devices

Other for A3 and other devices

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 13 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 210.
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 210.

209

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 authentication

Home Key

Scan preview

EquitracAuth ON

Available

Available

AutoStoreAuth OFF

Available

Available

Output ManagerAuth OFF

Available

Not Available

Output ManagerAuth ON

Available

Not Available

AutoStoreOutput ManagerAuth
ON

Available

Available

AutoStoreOutput ManagerAuth
ON

Available

Available

EquitracAutoStoreAuth ON

Available

Available

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 re
achable if the IP address is not valid or the device is currently not visible on the network.
Unified Client Ap
plication Status

Scan GUI Service Status

Status Message

Installed

Installed

Installed; Version: Clien

t: version - Scan GUI Ser
vice: version

Installed

Not installed

Installed; Version: Clien

t: version - Scan GUI Ser
vice: Not installed

Installed

Error

Installed; Version: Clien

t: version - Scan GUI Ser
vice: Error message

Not Installed

Not Installed

Not Installed

Not Installed

Installed

Not Installed

Error

Error message

210

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 configuration 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 g

roup file.

RicohSOP_XXXX.zip

RicohSOP.xml

Package metadata file for version nu

mber XXXX (such as RicohSOP_4
308.zip).

SmartScanEx_102.zip

Simple scan (GUI services) example

v1.02 for other (including A3) devic
es

SimpleScanEx_100_00.zip

Smart scan (GUI services) example v

1.00 for A4 devices

NEUF-RicohSmartSDK-authOf Client application v1.0 with no authe

f.zip
ntication.
NEUF-RicohSmartSDK-authOn Client application v1.0 with authenti
.zip
cation
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.
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

211

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Equitrac only
Nuance Application

Client Package

EQ only

Auth ON

Equitrac SSL
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

OM only

Auth ON

ON

AutoStore and Equitrac

Nuance Application

Client Installed

AutoStore Server SSL

AutoStoreEquitrac

Auth ON

OFF

AutoStoreEquitrac

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.

212

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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 afterwards 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.

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 R
egistration Service\Service\Plugins\RX
OP-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.propertie
s
10.56.59.35_20160802221451.propertie
s

213

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Action

Description
10.56.59.35_20160805204754.propertie
s
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

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

Configuration successfully completed.

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

214

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Return Code

Description
Device unreachable

503

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: Clien

t: 1.14.189 Scan GUI Se
rvice: 1.00.00

Installed

Not Installed

Installed; Version: Clien

t: 1.14.189 Scan GUI Se
rvice: Not installed

Installed

Error

Installed; Version: Clien

t: 1.14.189 Scan GUI Se
rvice: Error message

Not Installed

Not Installed

Not Installed

Not Installed

Installed

Not Installed

Error

Error message

Troubleshooting the Nuance Unified Client for Ricoh Smart Operation

Panel
Issue
Home key on an MFP was not
enabled by Assign as home key
application Device setting.

Cause
Device configuration may not be
implemented yet for a particular
MFP.

Solution
You can enable the Home key
manually on an MFP using the
following procedure:

Need to use the Auth Off client on

the MFP.

Device configuration may not be

implemented yet for a particular
MFP.

You can manually configure the MFP

to use the Auth Off client using the
following procedure:

215

How to enable Home Key settings

on page 216

Device Config for AuthOff on

page 218

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Issue

Cause

Need to manually configure SP

Modes on a device.

Solution

SP Modes are normally configured

by running Actions on a device.

You can manually configure SP

Modes on a device using the
following procedure:

How to configure SP Mode

settings on page 219

Property files generated during action with Equitrac as print manager

EquitracHome=True and Scan=True
Install and Reboot

deviceconfig_tracking_off.properties
default_deviceconfig.properties
deviceconfig_to_auth_on_preinstall.p
roperties

Configure and Reboot

deviceconfig_auth_on.properties
deviceconfig_home_key_on.properties

Uninstall

deviceconfig_tracking_off.properties
default_deviceconfig.properties

Install and Reboot

deviceconfig_tracking_off.properties
default_deviceconfig.properties
deviceconfig_to_auth_on_preinstall.p
roperties

Configure and Reboot

deviceconfig_auth_on.properties

Uninstall

deviceconfig_tracking_off.properties
default_deviceconfig.properties

EquitracHome=False and Scan=False

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.

216

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Figure 43: SOP device System Service settings

4. Press Screen Device Settings.
5. Press Home Key Settings.
This displays the Home Key settings screen.

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.

217

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.
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.

218

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

4. For Tracking Permission, press Off to turn off print tracking.

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.
2.
3.
4.

On the Home screen, go to Printer (scroll screen) and press the Printer icon.
Enter SOP Service Mode mode to complete the succeeding steps.
Press System Sp (press 0 to change bit from 0 to 1, then # to save).
Press SP Direct.

219

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

9. Navigate to User Tools > Machine Features > System Settings > Administrator Tools > User Authentication
Management Setting, and on the Custom Auth. tab, enable LDAP authentication.

220

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

The label LDAP authentication in step 8 will be changed to Custom authentication after the machine is
rebooted.
10. Configure the LDAP server, as described in How to set up the LDAP server on page 150.
11. Enable Machine action when limit is reached in System Settings (Administration tools).
Set this to Stop Job or Finish Job and Limit.

12. Set Auto Delete User in Address Book to On in System Settings (Administration tools).

13. Enable the network by setting User tools > Login > Exit > Screen Features > Interface Settings > Set to
Machine Network.

221

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Note: The authentication logic customization feature becomes valid when the following condition is
satisfied.
14. Log in as machine admin and navigate to User Tools > System Settings > Administrator Tools > Enhanced
Print Volume Use Limitation.

15. Turn on Tracking Permission.

222

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Nuance Unified Client for

Samsung
Overview
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:

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.

223

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Table 7: Unified Client Deployment Checklist

Check

Description

See

Confirm that your system meets requirements.

Requirements on page 224

Configure the Samsung in an AutoStore workflow using the

AutoStore Process Designer.

Samsung component help in AutoStore

Process Designer.

Add a DRS application for Nuance Unified Client for Ricoh

Smart Operation Panel

Add an application
Nuance Unified Client for Samsung
application properties on page 224

Add or import a Nuance Unified Client for Ricoh Smart

Operation Panel device

Add a device
Import a device
Nuance Unified Client for Samsung
device properties on page 225

Install, uninstall, or update settings for Nuance Unified

Client for Samsung.

Nuance Unified Client for Samsung

actions reference on page 226

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.

Supported devices

Version 7.0 SP1

Licensed for Samsung capture component
Task configured with the Samsung capture
component

Nuance Supported Device Search: Samsung

Reference
...

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 6.

224

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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
save

button to edit the parameters for a device. Click the

button to save changes to the parameters or click the cancel

Option

button to discard changes.

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.

225

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description

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.

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.

226

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

227

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Return Code

Description

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.

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 228

Unified Client application connection errors on page 229
Unified Client resets too quickly on page 230
Unified client registration error messages on page 230
Authentication registration error messages on page 232
Unified Client Unregistration error messages on page 232
Orphan Unified Client button on the device on page 233

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:

228

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Nuance Unified Client for Samsung application properties on page 224 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 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.

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 224 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 224 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 Output Manager Administration application.

229

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Nuance Unified Client for Samsung application properties on page 224 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

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.

Problem description

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.

Cause

Increase the device timeout interval to 3 minutes..

Solution
Unified client registration error messages
Code

Message

Comments

502

Unable to proceed. Please The device may be in faulted state

restart device.
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

retry login.

230

Verify that you enter the correct

device admin password in the device
Details pane in Device Registration
Service.

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Code

Message

Comments

504

Unable to connect to dev

ice. Please restart devi
ce.

505

Maximum registered applic

ations exceeded. Please r
emove unused applications
and retry.

506

Device is locked. Please

retry later.

507

Logo icon file does not e Contact Nuance Communications

xist. Contact Notable Sol Support.
utions Support.

508

Device solution key file Contact Nuance Communications

not found. Contact Notabl Support.
e Solutions Support.

509

Invalid Output Manager s

erver address. Enter corr
ect server address and re
try.

511

iOption not supported on

device. Add iOption or u
se the Native Scan connec
tor.

512

Invalid password. Enter t Reenter your credentials using a

he valid password and re valid password.
try.

518

Invalid AutoStore server

address. Enter the valid
address and retry.

519

Invalid Web application p The Web Application Port setting

ort number. Enter the val is blank or contains a negative
id port number and retry. number. Enter a valid port number
forWeb Application Port on

231

Verify that the device is not in

authentication mode or application
mode.

The Output Manager server address

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

The AutoStore server address is

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

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Code

Message

Comments
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. Please The device may be in a faulted

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

retry login.

504

Unable to connect to dev

ice. Please restart devi
ce.

506

Device is locked. Please

retry later.

Verify that the device is not in

authentication mode or application
mode.

509

Invalid Output Manager s

erver address. Enter corr
ect server address and re
try.

The Output Manager server

address is blank. Either enter the
Output Manager server address
on Applications tab of DRS or
set Enable Print Release as False
on Devices tab of the Device
Registration Service.

Verify that you enter the correct

device administrator password.

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
502

Message

Comments

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

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

232

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Code

Message

Comments

503

Invalid password. Please

retry login.

504

Unable to connect to dev

ice. Please restart devi
ce.

506

Device is locked. Please

retry later.

513

Unregistration failed bec There is no registered Nuance

ause no unified client ha Unified Client for Samsung
s been registered.
application.

Verify that you enter the correct

device administrator password.

Verify that the device is not in

authentication mode or application
mode.

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.

4. Select the Unified Client application and click Delete.

233

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

234

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Nuance Unified Client for

Xerox
Overview
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 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

235

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 8: Unified Client Deployment Checklist
Check

Description

See

Confirm that your system meets requirements.

Requirements on page 236

Configure the Xerox EIP component in an AutoStore workf

low using the AutoStore Process Designer.

Xerox EIP component help in AutoStore

Process Designer.

Add a DRS application for Nuance Unified Client for

Xerox.

Add an application
Nuance Unified Client for Xerox
application properties on page 240

Add or import a Nuance Unified Client for Xerox device.

Add a device
Import a device
Nuance Unified Client for Xerox device
properties on page 242

Register or unregister client, register or unregister account

ing, register or unregister authentication, or restart Nuance
Unified Client for Xerox .

Nuance Unified Client for Xerox

actions reference on page 245

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.

Equitrac

Version 7.0 SP1

Licensed for Xerox EIP capture component
Task configured with the Xerox EIP capture
component

The following is required it print management with

Equitrac is enabled in Device Registration Service.

236

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Requirement

Description

Output Manager

Equitrac Office or Express 5.6

The following is required it print management with

Output Manager is enabled in Device Registration
Service.

Supported devices

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.
Nuance Supported Device Search: Xerox

Configuring Nuance Unified Client for Xerox

Device Registration Service
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:

237

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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)\NSi\AutoStore W
orkflow 6\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 <clie
nt> 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 <!-- us
e 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.
4. Save the web.config file.
5. Change the URI setting for the Device Registration Service to https://IP_address:8069, where the IP_ad
dress 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://1
0.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)\NSi\AutoStore W
orkflow 6\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 <clie
nt> 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.

238

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 e
ndpoint 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_ad
dress 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.t
cp://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.
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 single-phase authentication
Configuring two-phase authentication
Proximity Card Readers
Magnetic Strip Card Readers

239

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

Configuration Reference
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.

240

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description

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:

Print Manager Address

Output Manager

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.

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.

241

Using

Do this

AutoStore only

The port number used

when configuring
the component with
AutoStore Process
Designer.

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Option

Description
AutoStore and Outpu
t 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.

button or canceled by clicking the Cancel

The following options are configurable for a Nuance Unified Client for Xerox device or device group for Xerox EIP.
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.

242

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

Application Name

The name that will be displayed on the device for the

default application.

Enable Print Print

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 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.

SNMP 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.

Default Functionality

Determines the default functionality for the client.

Options are:

Output Manager
AutoStore

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, Pro
perties, 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.

243

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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 Appli
cationProfile. 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.

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:
Name,

Xero
x,

IP,

Applic
ationP
rofile,

Devic
eType,

Device
Group

1.20
1.8.1
2,

Xerox
Prof
ile,

Xerox
EIP,

Prope
rties,

Applica
tionNam
e=Notab
le Solu
tions U
nified
Client~
EnableP
rintRel
ease=fa
lse~Des
tinatio
nSpecif

244

Inherit
Proper
tyFrom
Group,

SerialN
umber,

Usern
ame,

True,

Pass
word

12345
678

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Name,

IP,

Applic
ationP
rofile,

Devic
eType,

Device
Group

Prope
rties,

Inherit
Proper
tyFrom
Group,

SerialN
umber,

Usern
ame,

True,

Pass
word

icPrint
=false,
Xero
x,

1.20
1.8.1
4,

Xerox
Prof
ile,

Xerox
EIP,

Xero
xGrou
p,

Applica
tionNam
e=Notab
le Solu
tions U
nified
Client~
EnableP
rintRel
ease=fa
lse~Des
tinatio
nSpecif
icPrint
=false,

12345
678

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.

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.

Unregister Accounting

Unregisters Accounting on the device.

Restart

Restarts the device.

245

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

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.

246

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Return Code

Description

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.

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.

Using the Nuance Unified Client for Xerox

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.

247

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Figure 44: Output Manager login page

Figure 45: AutoStore login page

After the user logs in, the Nuance Unified Client for Xerox initially shows unprinted documents in table format.
Secure Print page provides more information.

Figure 46: Initial view in the Xerox Unified Client

Print jobs

248

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Delete jobs
View printed jobs
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.

Command buttons
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 Nuance Unified Client for

Xerox session and returns to the
login screen.

249

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Button

Name
Exit

Description
Closes the Nuance Unified Client for
Xerox application.

Print documents
Delete documents
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.

Command buttons
Button

Name
Scan image

Description
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.

250

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Button

Name

Description

Print

Switches to Output Manager.

Logout

Ends the Unified Client session and

returns to the login screen.

Exit

Closes the Xerox Unified Client

application.

Switch between AutoStore and Output Manager

Log out or exit

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 Xerox Unified Client

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.

Figure 47: Output Manager login page

251

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Figure 48: AutoStore login page

After the user logs in, the Xerox Unified Client initially shows unprinted documents in table format. Secure Print
page provides more information.

Figure 49: Initial view in the Xerox Unified Client

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.

252

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

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.

253

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Command buttons
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.

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.

254

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Command buttons
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.

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.

255

2016 Nuance Communications, Inc. All rights reserved.

Device Registration Service User Guide

Version 7.6

Command buttons
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.

256

2016 Nuance Communications, Inc. All rights reserved.