Use DRS to configure and deploy the unified client

Administrative access to the server is required. Perform these steps from the server where the installation takes place.
If you are using Microsoft Internet Explorer, go to Start > Administrative Tools > Server Manager > Local Server > IE Enhanced Security Configuration and turn off Administrators.
  1. If you are using Output Manager 5.3.1, you can install Device Registration Service (DRS) within ControlSuite. If you are using Output Manager 4.0, install DRS separately:
    1. Unzip the <version_number>-DeviceRegistrationService.zip from Download installer packages. This creates a new folder containing the DeviceRegistrationService.exe file.
    2. Right-click the file and select Run as administrator.
    3. Follow the instructions to install DRS.
  2. Upload the Ricoh Client Package.
    1. Download the Unified Client for Ricoh SOP software package, KofaxRicohUnifiedClient-<version>.zip, from the Kofax Downloads Web site (https://delivery.kofax.com).
    2. Unzip the file. This creates a new folder, containing the RicohSOP<version_number>.xml file.
    3. 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.
    4. Select the Files tab.
    5. From the Device Type list, select Ricoh SOP.
    6. 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 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 MFP based on the device configurations. The administrator can also install the latest version of the client, or a previous version (until that version is retired or is not supported).

      After installing DRS, the uploaded files (using Files tab in DRS) are not part of the installer and will not be removed with the uninstallation.

      You can delete cached user information and transactions on the device by uninstalling then re-installing the unified client.
  3. Create the application in DRS.
    1. Select the Applications tab.
    2. Click the green () button at the top of the left Applications pane.
    3. In the Name field (required), enter a name for the application.
    4. In the Application Type list (required), select Ricoh SOP.
    5. In the Server Configuration list (required), select Output Manager.
    6. In the Print Manager Address field, enter the IP addresses or the hostnames used by the Output Manager Server.
    7. In the Print Manager TLS Port field, enter the port number used by the Output Manager Server.
    8. In the Print Manager Use TLS field, select True or False.
    9. For the Trust Self-signed Certificate for Output Manager 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.
    10. For the Server Certificate Pinning option, select True to bind a certificate to the Output Manager server upon connection and use it to validate the trust of subsequent communications with that server.
    11. If Trust Self-signed Certificate for Output Manager is False and Print Manager 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.
    12. 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.
    13. In the Authentication entry (required), select True.
    14. Click Save() .
  4. Add the device in DRS.
    1. Select the Devices tab.
    2. Click the green () button at the top left of the Devices pane.
    3. In the Name field (required), enter a name for the Ricoh device or device group that identifies it on the network.
    4. 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.
    5. Enter the Username and Password for the device.
    6. From the Application list (required), select the application you have created. The rest of the Add Device fields appear.
    7. 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.
    8. 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.
    9. In the Enable Debug Log entry, select True or False.
    10. 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 will affect available workflow applications.
    11. In the Authentication Screen field, select Welcome (default) or Logon.
    12. In the Card Reader Model list, select the type of card reader for the device.
    13. In the Card Reader PID field, enter the specific Product ID number.
    14. In the Card Reader VID field, enter the specific Vendor ID number.
    15. In the Assign as Home Key Application field, choose select True or False.
    16. 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.
    17. In the Customize Assets field, choose True or False. If True is selected, additional fields appear.
      • In the Application Logo list (required), select relevant image file. The following image types are available: JPG, JPEG, PNG or BMP.
      • In the Welcome Screen Image list (required), select relevant image file.
        Once the logo shown on the Welcome Screen is customized, a smaller logo size is added to the top left hand corner of the Welcome Screen.
      • 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 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.
    18. In the Customize Workflow Buttons field, choose True or False. If True is selected, the Workflow Application field appear. Choose the available workflow applications for your device.
    19. 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.
    20. Click Save () at the top of the Add Device pane.
  5. Install the client application onto the device.
    1. From the list at the top of the Details pane, select one of the options depending on your preferences. For details, see Unified Client for Ricoh actions reference.
    2. Click the Run Action () button to run the action. The installation action may take a few moments to complete. Once finished, a Successfully completed message appears in the Action History pane at the bottom of the screen.
    3. From the Select Actions list, select Full Install.
    4. 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.