Use DRS to configure and deploy the unified client
-
If you are using Equitrac 6.3.1 and AutoStore 8.3.1, you can install Device
Registration Service (DRS) within ControlSuite. If you are using Equitrac 5.6 or
5.7 and AutoStore 7 SP6, install DRS separately:
- Unzip the <version_number>-DeviceRegistrationService.zip from Download installer packages. This creates a new folder containing the DeviceRegistrationService.exe file.
- Right-click the file and select Run as administrator.
- Follow the instructions to install DRS.
-
Upload the Ricoh Client Package.
- Download the Unified Client for Ricoh SOP software package, KofaxRicohUnifiedClient-<version>.zip, from the Kofax Downloads Web site (https://delivery.kofax.com).
- Unzip the file. This creates a new folder, containing the RicohSOP<version_number>.xml file.
- Open DRS. In a Web browser, enter http(s)://<DRSServerIP>:9000/device, where DRSServerIP is the IP address of the server where you installed DRS.
- Select the Files tab.
- From the Device Type list, select Ricoh SOP.
-
At the bottom of the screen, click Upload. Go to
the KofaxRicohUnifiedClient-<version>.zip file,
unzip it, and upload the files. You can also upload any images you want
to use to customize the Welcome screen. The file
type restriction is also validated, with a message listing the allowed
extensions when errors appear.
Future updates of the client configurations can be also uploaded from here.
The administrator can check build information for the specific package version and DRS decides what should be installed to the device based on the device configurations. The administrator can also install the latest version of the client, or a previous version (until that version is retired or is not supported).
After installing DRS, the uploaded files (using Files tab in DRS) are not part of the installer and will not be removed if you uninstall.
You can delete cached user information and transactions on the device by uninstalling then re-installing the unified client.
-
Create the application in DRS.
- Select the Applications tab.
-
Click the green (
) button at the top of the left Applications pane.
- In the Name field (required), enter a name for the application.
- In the Application Type list (required), select Ricoh SOP.
- In the Server Configuration list (required), select AutoStore and Equitrac.
- In the AutoStore Server Address field (required), enter the IP address or hostname used by the AutoStore server.
- In the AutoStore Server Port field, enter the server port used by the AutoStore server. The default value is 3310 (previously 3350).
- In the AutoStore Server Use TLS field, select True or False. This setting must match your AutoStore server configuration. Verify it in the Preference tab of the Ricoh SOP component. By default, the AutoStore setting Use TLS is on.
-
For the Trust Self-signed Certificate for
AutoStore option, select True or
False.
- If you are using a CA certificate, select False.
- You must use either all self-signed certificates or all CA certificates. You cannot combine the two types of certificates.
- In the DCE Server Address fields (required), enter the IP address or the hostname used by the DCE Server. If your deployment contains multiple DCE servers, up to three more can be added in the remaining DCE Server fields.
-
For the Trust Self-signed Certificate for DCE
option, select True or
False.
- If you are using a CA certificate, select False.
- Upload CA certificate files from the Files tab.
- You must use either all self-signed certificates or all CA certificates. You cannot combine the two types of certificates.
- For the Server Certificate Pinning option, select True to bind a certificate to the Equitrac DCE upon connection and use it to validate the trust of subsequent communications with that server.
-
If Trust Self-signed Certificate for AutoStore
or Trust Self-signed Certificate for DCE Server
is False and AutoStore Server Use
TLS is True, then the
Server Certificates field appears. Select the
server certificate file from the list.
Include all server certificate files into one zip file, with a maximum of five server certificate files. Only Base-64 encoded X.509 (.cer) certificates are supported.
- For the Bypass Button option, select True to allow a user to skip authentication to use the device native functions without logging in or False to remove this option.
- In the Authentication entry (required), select True.
-
Click Save (
) .
-
Add the device in DRS.
- Select the Devices tab.
-
Click the green (
) button at the top left of the Devices pane.
- In the Name field (required), enter a name for the Ricoh device or device group that identifies it on the network.
-
In the Address field (required), enter the IP
address or the hostname of the device.
For the IP address, you can enter IPv4 or IPv6 addresses depending on the configuration of your system. If you enter an IPv6 address, brackets ([ ]) are automatically added to it if missing when you exit from the field.
- Enter the Username and Password for the device.
- From the Application list (required), select the application you have created. The rest of the Add Device fields appear.
-
In the Remote Install Password field (required),
enter the administrator password.
This password can be changed by the device administrator regardless of the domain credentials.
-
In the MFP TLS (http/https) entry, select
True (default) or
False. It is recommended that you use https
or higher TLS settings for installation.
The following DRS actions only support HTTPS: Quick Install, Full Install, Configure and Reboot, and Quick Configure.
- In the Enable Debug Log entry, select True or False.
- In the Server Connections Timeout entry (the timeout used by DRS when making configuration and installation calls to the device such as SP modes and deployment of the client.), select a specified period of time (default is 60).
-
In the Device Type list (required), choose
between Single-Function Printer (SFP),
Multi-Function Printer (MFP) or Specific model
(MP C306/MP C406) device.
This selection affects available workflow applications.
- In the Authentication Screen field, select Welcome (default) or Logon.
- In the Card Reader Model list, select the type of card reader for the device.
- In the Assign as Home Key Application field, select True or False.
- In the Scan preview entry, select True or False.
- In the Application Package list (required), 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.
-
In the Customize Assets field, choose select
True or False. If
True is selected, the following fields
appear:
- In the Application Logo list (required), select the image file. The following image types are available: JPG, JPEG, PNG or BMP.
- In the Welcome Screen Image list (required), select relevant image file.
- In the Customize Welcome Screen Text field, choose True or False. If True is selected, the Welcome Screen Text field appears. Enter your text.
- In the Customize Application Name field, choose select True or False. If True is selected, the Application Name field appears. The default name is Kofax Unified Client. You can enter a new name, up to 60 unicode characters.
The information () icon next to the field names explains the file type, image resolution, and text length restrictions.
To upload the assets, go to the Files tab and select a file that conforms to the previous specifications. Once uploaded, the file appears in the list (for Application Logo and Welcome Screen Image, respectively depending on the uploaded file’s size).Uploaded files that do not conform do not appear on the list. - In the Customize Workflow Buttons field, choose True or False. If True is selected, the Workflow Application field appears. Choose the available workflow applications for your device.
-
In the Use Authorization Key field, select
True to use additional security between the DRS application and the
device, to confirm that only the initial DRS instance that was used
to deploy or configure the device can be used to update the
configuration on the device.
If you change this setting from True to False, you must uninstall the unified client and install it again to remove the cached DRSAuthKey on the device.
-
Click Save (
) at the top of the Add Device pane.
For more details, see Unified Client for Ricoh device properties.
-
Install the client application onto the device.
-
From the Select Actions list at the top of the
Details pane, select Full Install. For
details, see Unified Client for Ricoh actions reference.
To go back to the default values for assets, you must set and resync.
-
Click the Run Action icon (
) to run the action. This may take a few minutes to complete. Once finished, a Successfully completed message appears in the Action History pane at the bottom of the screen.
-
From the Select Actions list at the top of the
Details pane, select Full Install. For
details, see Unified Client for Ricoh actions reference.
- Locate the auto-added device and configure it in Equitrac System Manager. For instructions, see the Server-side configuration.