Import guidelines

This topic provides guidelines for importing Ricoh ESA device information into Device Registration Service with a comma separated values (CSV) file.

Ricoh ESA 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 Output 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:
  • Output Manager
  • AutoStore
Authentication (*)
Determines the authentication mode. Options are:
  • OM Authentication with Device Access Control
  • OM Authentication
  • Device Authentication
  • AutoStore Authentication
  • External AAA Provider
  • CAP

Ricoh authentication modes provides more information on authentication modes.

If you select OM Authentication with Device Access Control, OM 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 unsecure 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 Output Manager uses to the show date.

OMDateTimeFormat

Specify the format that Output 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 Ricoh ESA Unified Client 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 Ricoh ESA Unified Client 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 Ricoh ESA Unified Client 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 Ricoh ESA Unified Client is active on the panel. On a device that operates with Java platform version 10.x or newer, the period of inactivity starts with a key or button click from any application.

DisplayDestinationSpecificDocumentsOnly

Set to True to show print jobs for only the device that you are configuring. For example, you set the value to True for device A. When users view print jobs at the device A panel, they see only the print jobs that they have submitted to device A. If the value is False, users see the print jobs that they have submitted to device A and to other destinations.

The default is True.

OMEnableSSOProvider
Set to True to enable single-sign-on (SSO) through a provider if users log in and log out through a device configured for Output Manager functionality. Verify that the following requirements are satisfied to enable SSO:
  • A third-party application wants SSO through the Ricoh Unified Client login.
  • A Notable Solutions SSO provider is installed.

The default is False.

SmartPanelCompatibilityMode

Enables authentication compatibility between the Ricoh ESA Unified Client 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 OM Authentication with Device Access Control, OM Authentication, or AutoStore Authentication. The Ricoh ESA Unified Client 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, DeviceGroup, Properties, InheritPropertyFromGroup, SerialNumber, Username, Password
Ricoh, 191.211.13.5, Ricoh Profile, Ricoh Group, EnablePrintRelease=true~EnableScan=true, TRUE, E153M310024, admin, ricoh
Ricoh, 191.211.13.9, Ricoh Profile, Ricoh Group, EnablePrintRelease=true~EnableScan=true, TRUE, E264M302574, admin, ricoh