DRS setup and device registration

Set up DRS and create an application for the Unified Client for Xerox. Before you begin, note the following:

  • Make sure you have administrative credentials for the device.

  • Make sure the device is not in an error state (such as from a paper jam or out of paper) before registering or unregistering the client on it. If the device is in an error state, registration or unregistration will fail.

  • The Unified Client for Xerox, when configured as the authentication agent, cannot coexist with another embedded client on the device that is also handling authentication. This includes the Kofax Combined Client for Xerox, Kofax Equitrac ECSP Client for Xerox, and Kofax EIP Client for Xerox. Unregister any embedded client that is configured as an authentication agent before registering the Unified Client for Xerox.

    The ControlSuite server can support multiple Kofax embedded solutions for Xerox. So, it can support certain Xerox devices running the Unified Client for Xerox and other Xerox devices running with other Kofax embedded clients, such as Kofax Combined Client for Xerox, Kofax Equitrac ECSP Client for Xerox, and Kofax EIP Client for Xerox.

Then, do the following:

  1. Install DRS and make sure that the Device Registration System service is running.
  2. Create the application in DRS.
    1. Select the Applications tab.

      For an explanation of the fields in this tab, see Unified Client for Xerox application properties

    2. Click the green Add (Add button) button at the top of the left Applications pane. The Add Application function loads into the right pane.
    3. In the Name field (required), enter a name for the application. You can use any name.
    4. In the Application Type field (required), select Xerox Unified Client.

      Additional fields appear.

    5. Enter the addresses of the DWS servers.
    6. In the Server Configuration field, enter the server configuration to be used for the application.

      Note the following:

      • The selections you make should reflect your server configuration as defined in ControlSuite.

      • If you use Equitrac or Output Manager, additional fields appear for authentication. For Authentication, select True to use the Unified Client for Xerox as the authentication application on the device or False to use another authentication application.

        Note:

        If authentication is managed by CAC, Authentication must be set to False. The CAC user name must match the User principal name field for the user's Windows user account in Output Manager. Otherwise, single-sign-on will fail.

    7. In the fields that appear, enter the host name or address, port, and other configuration settings for the servers.

      The selections you make should reflect your server configuration as defined in ControlSuite.

      For each server, select whether or not you are using TLS. For the port number, select the following depending on what servers you use:

      • If you are using AutoStore, enter the port number in the AutoStore Server TLS Port if TLS is used or AutoStore Server Port if TLS is not used.

      • If you are using Equitrac, enter the DCE server names.

      • If you are using Output Manager, enter the port number in the Print Manager TLS Port if TLS is used or Print Manager Port if TLS is not used.

      The default port number is 8069 if TLS is used or 8068 if TLS is not used.

    8. Click the Save button (Save button) at the top of the Add Application screen.
  3. Register the device in DRS.
    1. Select the Devices tab.

      For an explanation of the fields in this tab, see Unified Client for Xerox device properties

    2. Click the green Add (Add button) button at the top of the left Devices pane. The Add Device function loads into the right pane.
    3. In the Name field (required), enter a name for the Xerox device that identifies it on the network.
    4. In the Address field (required), enter the IP address or the hostname of the device.
    5. Enter the Username and Password for the device.
    6. In the Application field, select the application you have created from the list.

      Based on the application you select, fields that apply to that application appear.

    7. In the Device Port field, use the default port of 443 or change it to the appropriate port number.
    8. For the Decentralized field, select True (the default setting) to use decentralized workflows or false to access Kofax workflows through the Unified Client for Xerox.

      For more information about decentralized workflows, see Centralized and decentralized workflows.

    9. Complete the fields for the SNMP server, which are required. Note the following:
      • SNMP must be configured for version 3.

      • The SNMP Encryption Algorithm and SNMP Digest Algorithm fields must match the settings for the device.

    10. If desired, you can customize the application name and authentication screen:
      • To change the name of the applications as they appears on the device, set Customize Application Name to True and enter the names in the application name fields. To use the default application name, set Customize Application Name to False.

      • To customize the authentication screen, set Customize Authentication Screen to True and enter the text that you want to appear in the Authentication Title and Authentication Message fields. To use the default text, set Customize Authentication Screen to False.

      Note:

      If you need to change the application name or return to default values, the app must be registered again.

    11. Click the Save (Save button) button at the top of the Add Device pane.
  4. Register Unified Client for Xerox client application on the device.
    1. From the drop-down list at the top of the Details pane, select Install and Configure.
    2. Click the Run Action button Run Action button. You can follow deployment status feedback under Action History. The register 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.
      Note:

      If you are using a VersaLink device and Authentication is on, the device is restarted at the end of installation and uninstallation.