Install AutoStore - ControlSuite

To install AutoStore, do the following:
  1. Download the installer package (Web Installer or Offline Installer) and run the InstallAssistant application.
  2. Click Get Started on the Welcome page.
  3. A Questionnaire page opens asking Do you want to check for updated Install Assistant files? Select Yes or No and then click Next to continue.
    If "Yes" is selected, any updated Install Assistant configuration files will be downloaded from the software download server. The files that require updating are not overwritten, and the system creates a backup file with a .bak extension for the older files. Once any updated files are downloaded, click OK on the popup message to continue with the installation.
    Select "No" to continue with the installation without checking for updates.
  4. When asked Do you want to create an offline installer package? select Yes or No and then click Next to continue.
    If "Yes" is selected, a Summary page opens with Offline installer package location field and the package name. Click Next to continue. The Install Assistant will download all ControlSuite component installers and create an offline installer package, but will not install ControlSuite. The Results page opens displaying that the offline installer package was successfully created. Click Finish to continue. See Create an offline installation package for details.
    If "No" is selected, the installation process continues.
  5. When asked ControlSuite is already installed on this system. Would you like to uninstall ControlSuite? select Yes or No and then click Next to continue.
    If "Yes" is selected, all ControlSuite components are uninstalled and removed from the server. Click Yes on the popup message to uninstall ControlSuite and to continue with the installation.
    Select "No" to continue with the installation without uninstalling ControlSuite.
    This option only removes the ControlSuite components. See Uninstall ControlSuite to delete IIS bindings, and to remove any files, folders, certificates or registry entries that may have been leftover from the initial uninstall.
  6. When asked Do you want to use the Install Assistant Wizard or manually configure the server? select one of the following option and click Next.
    • Use the Install Assistant Wizard (recommended) - Select this to use the wizard to walk you through the installation process.
    • Manually Configure - This option is intended for advanced users who are familiar with the components. This options skips the questionnaire and goes directly to the Advanced installation page.
  7. When asked What software do you want to install on this server? select AutoStore document and image capture, and click Next.
    Your license determines the functionality that is available. Some of the features selected to install may not be enabled if you do not have the correct licensing package.
  8. When asked Are you installing AutoStore in a production environment or do you want to build a demo or POC server? select I am building a AutoStore production environment and click Next.
  9. When asked Will this be your primary AutoStore document and image capture server? select one of the following options and click Next.
    • Yes, this will be my primary AutoStore document and image capture server - This installs the core AutoStore document and image capture features.
    • No, this server will support AutoStore document and image capture but will be a secondary server - Select this option if you already have a primary AutoStore server, but want to add other processes to this server.
  10. When asked What additional document and image capture capabilities will this server support? Select any or all of the following options and click Next.
    • Capture from MFP Devices
    • Capture from desktop, web and all other non-MFP sources
    • Document Transformation
    • Processing Components (OCR, Image, Cleanup, etc) - This is only available when selecting the secondary server option.
  11. When asked Which product do you want to use for Authentication (Foundations) and Follow-You Print (Enterprise)? select one of the following and click Next.
    • Equitrac - This installs the core Equitrac print management components (for example, print sever, web-based System Manager, and configuration, authentication and accounting service)
    • Output Manager - This installs the Output Manager Input and Output services.
    • No, I do not want to install these features
  12. When asked Will this server be used to support mobile devices? select Yes or No and click Next.
  13. When asked Which of the following ControlSuite shared services or tools would you like to install on this server? select any or all of the following, and click Next.
    • License Server - This is required on at least one ControlSuite server to enable and enforce licensed entitlements.
    • Security Framework - This is required on at least one ControlSuite server to broker communication between ControlSuite components.
    • Device Registration - This is required to register and configure MFP devices and to initialize and configure Mobile on MFPs.
    • Device Web Service (DWS) - This is required to support web-based MFP devices.
  14. When asked Do you want to install ControlSuite Device Control Service? select No and click Next.
  15. A Summary page opens displaying the components to be installed and deployed in an AutoStore production environment. The components are grouped into their respective functionality. For example, ControlSuite contains Security Framework and Licensing as these are used by all groups, and AutoStore contains all Capture components. Click Next to continue.

    Click the Advanced link if you want to modify the components to be installed. At this point you can select additional components, but the previously selected components cannot be updated or modified. In order to modify pre-selected components, you need to go back and change your selection through the questionnaire. After any changes have been made click Save and Next to continue.

  16. A second Summary page opens with ControlSuite installer download options and the Installation location. The default location is C:\Program Files, or you can click Browse to select a different location. Click Next to continue.

    Select one or more of the following options, and then click Next to continue.

    • Force download of latest installers - Install Assistant verifies that the latest installers are currently on your system, and if they are not the latest, it downloads updated installers overriding the older files in the Installs folder. This is not required, and will increase the installation time.
    • Automatically continue with install once all required installers are available - Install Assistant verifies that the required installers are currently on your system and then continues with the installation. Any missing installers are automatically downloaded, but this option does not check if you have the latest versions of the installers on your system. Select this option and the "Force download of latest installers" option to ensure you have a complete up-to-date set of installers before proceeding.
    • Download only - will not check local system for prerequisites or install - Install Assistant downloads the selected components but does not check for prerequisites or install the selected components. Using this option allows customers to download the necessary MSIs and generate an offline installer package that can then be distributed and installed within an offline deployment. When this option is selected, Install Assistant proceeds directly to the Results page displaying a "Successfully downloaded selected components" message. Click Finish when done.

    When no options are selected, Install Assistant downloads any missing selected components, and then displays a message stating "All selected components are downloaded. Continue with install?" If you select Yes, the installation continues. If you select No, Install Assistant proceeds directly to the Results page displaying a "Successfully downloaded selected components" message. Click Finish when done.
    When the "Download only" option is selected, the "Automatically continue with install" option and the Installation location field are disabled (grayed-out), and the installation process is not available.

    If installing the Web Installer package, which only contains the Install assistant, the installers for the services selected in the Questionnaire will be downloaded and will populate the Install folder of the Web Installer package.

    If installing the Offline Installer package that contains all installers, it can be run locally on the server without an Internet connection. The Offline version contains every installer required for any possible installation setup, and not all installers may be needed for your deployment. As the files are being installed, the C:\Program Files\Nuance\<Product> folders are populated with the selected services.

  17. A Prerequisites page opens displaying the status of the system requirements needed to install and run the selected components.
    • A green checkmark beside the feature indicates that the requirements have been met.
    • A red ’X’ means that a particular feature does not meet the minimum requirement and must be installed or updated before the installation can continue.
    • A yellow warning means that the minimum requirements are met, but does not meet the preferred requirements to run with optimum results.
    If a component needs to be installed or updated, click the top level feature to show the list of required features to be fixed.
    If any software needs to be updated, click the Install Prerequisites button to automatically install the software. This button is only available for software prerequisites. Alternatively, click the link beside the software component to open the website to download and manually install the required software.
    If you continue to install with any prerequisites with a warning, a pop-up opens asking if you are sure you want to continue with the installation. Click Yes if you want to proceed with the knowledge that you may encounter some performance issues, or click No if you want to fix any requirements before installing.

    After addressing any hardware or ports prerequisites issues, click Retry, and then click Next to continue once the requirements are met.

  18. A Download page opens showing the progress of the downloaded components.
  19. An Install page opens, and the install starts automatically.

    During the install process, you can Cancel or Rollback the installation.

    • Cancel stops or pauses the install but does not remove already installed components. The previous selections are saved and administrators can re-run the install at a later date and continue where they left off.
    • Rollback stops the install and uninstalls any components that have been installed to that point.

  20. The Results page opens displaying that the installation was successful. Click Finish to continue. By default, the Automatically run Configuration Assistant after reboot option is selected to immediately configure ControlSuite. Clear this option if you want to only install ControlSuite and configure it at another time. Go to Configuring ControlSuite.
    You must restart the server before configuring ControlSuite.

Install Equitrac - ControlSuite

To install Equitrac, do the following:
  1. Download the installer package (Web Installer or Offline Installer) and run the InstallAssistant application.
  2. Click Get Started on the Welcome page.
  3. A Questionnaire page opens asking Do you want to check for updated Install Assistant files?Select Yes or No and then click Next to continue.
    If "Yes" is selected, any updated Install Assistant configuration files will be downloaded from the software download server. The files that require updating are not overwritten, and the system creates a backup file with a .bak extension for the older files. Once any updated files are downloaded, click OK on the popup message to continue with the installation.
    Select "No" to continue with the installation without checking for updates.
  4. When asked Do you want to create an offline installer package? select Yes or No and then click Next to continue.
    If "Yes" is selected, a Summary page opens with Offline installer package location field and the package name. Click Next to continue. The Install Assistant will download all ControlSuite component installers and create an offline installer package, but will not install ControlSuite. The Results page opens displaying that the offline installer package was successfully created. Click Finish to continue. See Create an offline installation package for details.
    If "No" is selected, the installation process continues.
  5. When asked ControlSuite is already installed on this system. Would you like to uninstall ControlSuite? select Yes or No and then click Next to continue.
    If "Yes" is selected, all ControlSuite components are uninstalled and removed from the server. Click Yes on the popup message to uninstall ControlSuite and to continue with the installation.
    Select "No" to continue with the installation without uninstalling ControlSuite.
    This option only removes the ControlSuite components. See Uninstall ControlSuite to delete IIS bindings, and to remove any files, folders, certificates or registry entries that may have been leftover from the initial uninstall.
  6. When asked Do you want to use the Install Assistant Wizard or manually configure the server? select one of the following option and click Next.
    • Use the Install Assistant Wizard (recommended) - Select this to use the wizard to walk you through the installation process.
    • Manually Configure - This option is intended for advanced users who are familiar with the components. This options skips the questionnaire and goes directly to the Advanced installation page.
  7. When asked What software do you want to install on this server? select Equitrac print management, and click Next.
    Your license determines the functionality that is available. Some of the features selected to install may not be enabled if you do not have the correct licensing package.
  8. When asked Are you installing Equitrac in a production environment or do you want to build a demo or Proof of Concept (POC) server? select I am building an Equitrac production environment and click Next.
  9. When asked Will this be your primary Equitrac Core Accounting Server (CAS)? select one of the following options and click Next.
    • Yes, this will be my primary Equitrac Core Accounting Server (CAS) - This installs the Equitrac core configuration, authentication and accounting features.
    • No, this server will host a secondary CAS or support print management capabilities - Select this option if you already have a primary Equitrac server, but want to add other print capabilities to this server.
  10. When asked What additional Equitrac print management capabilities will this server support? select any or all of the following options and click Next.
    • Print Server (DRE)
    • MFP Device Support
    • Web-based System Manager - This installs the Equitrac Web System Manager.
    • Device Monitoring (DME)
    • Device Control (DCS)- This is required to support Ethernet card readers or Konica Minolta Combined Client (iOption)
    • Host-based printing powered by Output Manager - This is only for Equitrac Enterprise installations.
    • Equitrac Configuration and Reporting Utilities - This enables the configuration of the Equitrac Windows System Manager, which includes Print Driver Repository, Campus Card and Reports Manager. Refer to the Kofax Equitrac Windows System Manager Guide to install and configure the Windows System Manager components.
    • Reporting/Secondary CAS Server - This is only available when selecting the secondary CAS option.
  11. When asked Which Capture functionality do you want to install? select one of the following options and click Next.
    • Equitrac Capture & Send - Equitrac scanning only supports Xerox, Fuji-Xerox, Ricoh and Toshiba devices.
    • Enhanced Capture powered by AutoStore - This installs the core AutoStore capture and processing components.
    • I do not want to install Capture functionality on this server
  12. When asked Will this server be used to support mobile devices? select Yes or No and click Next.
  13. When asked Which of the following ControlSuite shared services or tools would you like to install on this server? select any or all of the following, and click Next.
    • License Server - This is required on at least one ControlSuite server to enable and enforce licensed entitlements.
    • Security Framework - This is required on at least one ControlSuite server to broker communication between ControlSuite components.
    • Device Registration - This is required to register and configure MFP devices and to initialize and configure Mobile on MFPs.
    • Device Web Service (DWS) - This is required to support web-based MFP devices.
  14. A Summary page opens displaying the components to be installed and deployed in an Equitrac production environment. The components are grouped into their respective functionality. For example, ControlSuite contains Security Framework and Licensing, and Equitrac contains the required print management components. Click Next to continue.

    Click the Advanced link if you want to modify the components to be installed. At this point you can select additional components, but the previously selected components cannot be updated or modified. In order to modify pre-selected components, you need to go back and change your selection through the questionnaire. After any changes have been made click Save and Next to continue.

  15. A second Summary page opens with ControlSuite installer download options and the Installation location. The default location is C:\Program Files, or you can click Browse to select a different location. Click Next to continue.

    Select one or more of the following options, and then click Next to continue.

    • Force download of latest installers - Install Assistant verifies that the latest installers are currently on your system, and if they are not the latest, it downloads updated installers overriding the older files in the Installs folder. This is not required, and will increase the installation time.
    • Automatically continue with install once all required installers are available - Install Assistant verifies that the required installers are currently on your system and then continues with the installation. Any missing installers are automatically downloaded, but this option does not check if you have the latest versions of the installers on your system. Select this option and the "Force download of latest installers" option to ensure you have a complete up-to-date set of installers before proceeding.
    • Download only - will not check local system for prerequisites or install - Install Assistant downloads the selected components but does not check for prerequisites or install the selected components. Using this option allows customers to download the necessary MSIs and generate an offline installer package that can then be distributed and installed within an offline deployment. When this option is selected, Install Assistant proceeds directly to the Results page displaying a "Successfully downloaded selected components" message. Click Finish when done.

    When no options are selected, Install Assistant downloads any missing selected components, and then displays a message stating "All selected components are downloaded. Continue with install?" If you select Yes, the installation continues. If you select No, Install Assistant proceeds directly to the Results page displaying a "Successfully downloaded selected components" message. Click Finish when done.
    When the "Download only" option is selected, the "Automatically continue with install" option and the Installation location field are disabled (grayed-out), and the installation process is not available.

    If installing the Web Installer package, which only contains the Install assistant, the installers for the services selected in the Questionnaire will be downloaded and will populate the Install folder of the Web Installer package.

    If installing the Offline Installer package that contains all installers, it can be run locally on the server without an Internet connection. The Offline version contains every installer required for any possible installation setup, and not all installers may be needed for your deployment. As the files are being installed, the C:\Program Files\Nuance\<Product> folders are populated with the selected services.

  16. A Prerequisites page opens displaying the status of the system requirements needed to install and run the selected components.
    • A green checkmark beside the feature indicates that the requirements have been met.
    • A red ’X’ means that a particular feature does not meet the minimum requirement and must be installed or updated before the installation can continue.
    • A yellow warning means that the minimum requirements are met, but does not meet the preferred requirements to run with optimum results.
    If a component needs to be installed or updated, click the top level feature to show the list of required features to be fixed.
    If any software needs to be updated, click the Install Prerequisites button to automatically install the software. This button is only available for software prerequisites. Alternatively, click the link beside the software component to open the website to download and manually install the required software.
    If you continue to install with any prerequisites with a warning, a pop-up opens asking if you are sure you want to continue with the installation. Click Yes if you want to proceed with the knowledge that you may encounter some performance issues, or click No if you want to fix any requirements before installing.

    After addressing any hardware or ports prerequisites issues, click Retry, and then click Next to continue once the requirements are met.

  17. A Download page opens showing the progress of the downloaded components.
  18. An Install page opens, and the install starts automatically.

    During the install process, you can Cancel or Rollback the installation.

    • Cancel stops or pauses the install but does not remove already installed components. The previous selections are saved and administrators can re-run the install at a later date and continue where they left off.
    • Rollback stops the install and uninstalls any components that have been installed to that point.

  19. The Results page opens displaying that the installation was successful. Click Finish to continue. By default, the Automatically run Configuration Assistant after reboot option is selected to immediately configure ControlSuite. Clear this option if you want to only install ControlSuite and configure it at another time. Go to Configuring ControlSuite.
    You must restart the server before configuring ControlSuite.

License ControlSuite

  • The license server is installed with the ControlSuite Shared Services Installer.
  • It runs as a NDI License Service Windows service.
  • It installs to: C:\Program Files\Nuance\Shared Services\Licensing.
Use the following to license ControlSuite.

  1. From the Configuration Assistant Licensing page, click the Open Kofax Customer Portal link to get access to the Kofax Customer Portal. Alternatively, open a web browser and enter https://register.kofax.com/serialregistration.
  2. Login with your account credentials and Serial number. The login information can be found in the order confirmation email. For assistance registering and setting up an account, please see our knowledge base article on the Kofax (electronic Fulfillment) Delivery Site.
  3. Enter your License Server Name and ID. This information is found on the Configuration Assistant Licensing page your ControlSuite installation.
  4. Enter your License Server ID into the Kofax Licensing Platform.
  5. The system sends an email confirming that license registration was successful.
    To modify licensing, contact Kofax Technical Support.

License AutoStore - ControlSuite

Verify that the AutoStore licenses have transferred to the Licenses table on the View Server page.
If you install AutoStore Sunset Pack 8.1 after installing and licensing AutoStore 8.1, you have to refresh the license to activate the Sunset Pack components.
  1. Ensure that you are logged into an AutoStore server within your deployment.
  2. Launch the Configuration Assistant and go to the Licensing tab.
  3. Click Refresh Licenses then select Update license online and click Apply.
  4. The Refresh Licenses window displays progress. After successful completion, select the AutoStore Licensing tab.
    The AutoStore Licensing page shows all AutoStore licenses that you have purchased broken down by type (such as User, Capture and Processing Licenses).
    License The value of the license
    Available The total purchased number of a license
    Assigned to other server(s) Licenses already in use by other AutoStore server instances. If this is the first time that you are assigning AutoStore licenses this number is zero.
    Assign to this server License value to be assigned to this server
  5. Use the slider or type the desired license number directly into the Assign to this server box.
  6. Click Next. After the license assignment has completed successfully, click Close.
    You have finished distributing licenses to the AutoStore server instance.
  7. Repeat the above steps for all AutoStore server instances in your deployment.

Configure ControlSuite

  1. After installing ControlSuite, launch the Configuration Assistant. The Configuration Assistant can either be auto-launched as part of the Install Assistant finishing process, or by running the Configuration Assistant application found in C:\Program Files\Nuance\Configuration Assistant.
  2. Click Get Started on the Welcome page.
  3. A Databases page opens displaying the installed components, database instances and database names.

    The green checkmark beside the component indicates that the database is configured correctly. The red warning means that a particular configuration setting is not valid, and the database information must be updated before the configuration can continue. When the databases are validated, click Next to continue.

    To modify a database, click the Edit icon beside its name to open the Configure Component window, and select a Database Type - SQL Server, SQL Server Compact Edition or Oracle.

    The available database types depends on the installed ControlSuite component's supported databases.

    If selecting SQL Server, modify the following:

    • Authentication Type - Windows or SQL Server.
      • Windows (default selection): select this option when the user running the Windows Service account connects to the database server.
      • SQL Server: enter the user credentials in the Login and Password fields, (this can be another Windows user or a SQL Server user).
    • Instance - use the default, or select another instance from the list, or click Find to search for one not in the list.
    • Database Name - Enter the name of the database or select another database from the list.
    • Click the Test button to verify the database and server and functioning. A green check-mark displays when validated.

    If selecting SQL Server Compact Edition, enter the database Password, and click the Test button to verify the database and server and functioning.

    The initial SQL Server Compact database and default password are created automatically when Business Connect is installed.

    If selecting Oracle, modify the following:

    • DNS - Enter the name of the DNS Server.
    • Login and Password - Enter the Login and Password of the user with admin rights to the Oracle server.
    • Click the Test button to verify the database and server and functioning. A green check-mark displays when validated.

    It is recommended that a new database is created when installing Equitrac 6.0 on a server with an existing Equitrac database. Although direct upgrades from earlier versions of Equitrac to version 6.0 is not supported, Configuration Assistant may use the existing database and automatically upgrade it as required.

    A Running Database Scripts window opens to locate and connect to the selected databases. When successful, there is a green check-mark beside each item. Close the database script window when done. A red 'x' indicates that a the database was not setup properly.

  4. A Certificate Management page opens displaying the list of certificates associated with each component.
    1. Select the check box next to the component and select Generate Self-Signed or Import Certificate from the Select Action menu. Alternatively, click the + icon to generate a self-signed certificate, or click the Open file icon to import a certificate.
      • Generate Self-Signed - A pop-up opens where you can provide Friendly name and Expire date for the certificate. If you select the Save to file check box, enter a Password and File path to where to save the certificate, and click OK to continue.

        A Generate Certificate window opens to create the selected certificates. When successful, there is a green check-mark beside each item. Close the generate certificate window when done.

      • Import Certificate - A pop-up opens where you can select a certificate Filename and Password, and click OK. Alternatively, click the Browse button to open the location of stored certificates and select the desired file. Click OK to continue.
        Existing custom certificates with Equitrac services for HTTPS can be used when upgrading from Equitrac 6.0 to 6.1
    2. Click Next. A Binding Ports window opens updating the IIS certificates. When successful, there is a green check-mark beside each item. Close the binding ports window when done.
    3. Click Next to continue.
  5. A Core Services page opens with a list of the installed core services, along with their service credentials, startup type and current status.
    • Click the Actions icon beside the Distributed Database Service (DDB) and select Configure if you want to edit its default settings. You can edit the ports used and the data folder and log file locations. Click OK to save the changes or Cancel to leave the defaults. By default this service is not started and it cannot be manually started. The DDB service will start automatically once the security framework is configured.
    • Click the Actions icon beside the Licensing Service and select Configure if you want to change the Licensing Service Port used. By default Port 44370 is used by the ControlSuite licensing service. Select Start to start the licensing service if it not already running.
    • Click Next.
  6. An Authentication & Security page opens where you enter your Security Framework credentials and connections.
    When Security Framework Service (SFS) is installed, you can create security admin user credentials for the admin to have access to configure ControlSuite security registrations, or you can connect to an existing server where the Security Framework Services are running. The security admin credentials are created when you first install a security framework node, and will be required later.
    Security framework provides a secure infrastructure for ControlSuite shared components. ControlSuite services can register themselves with the Secure Service Discovery Service (SSDS) in order to locate other service locations in distributed deployments. The Authentication and Authorization (AA) service secures component to component communications and also restricts each component to only a specific set of authorized actions based on its component type.
    Enter the following information for the Service Discovery and Authorization Server:
    1. Username and Password- Create the Security Admin credentials if they do not exist. The Username must be in the form of domain\username. However, the domain is only utilized for ControlSuite, and is not associated with any AD Domain.
      When upgrading from Equitrac 6.0 to 6.1, all existing Equitrac clients and services will be automatically enrolled after logging in with the Security Admin credentials.
    2. Hostname - This is name of the system where Security Framework is installed on.
    3. Datacenter name - The datacenter is where one or more Security Framework Services are running.
      The datacenter name is created on the machine where the first instance of the SFS is installed. This datacenter is used to connect any additional SFS machines in your deployment.
    4. Click Apply.
    If you select the Connect to an Existing Server check box, do the following:
    1. Remote Host Address - This is the Host where another Security Framework Service is located
    2. Port - 8181 is the default Security Framework port.
    3. Admin Username and Password - These are the security admin credentials associated with the Security Framework Service.
    4. Click Login.
    5. Datacenter Hostname is pre-populated with the name created in the previous screen.
    6. Datacenter name - The datacenter is where one or more Security Framework Services are running. The list is populated with all available datacenters.
    7. Datacenter ID is auto-created when the Datacenter name was created.
    8. Click Apply and Next to continue.

    An Initializing Security Framework window opens to update the configuration and register the distributed database. When successful, there is a green check-mark beside each item. Close the security framework window when done.

  7. A CS Enrollment page opens where you enroll services into the Security Framework.
    • Select all the services that need to be enrolled. By default all servers need to be enrolled. Choose Enroll from the Choose list. Alternatively, you can select Enroll from the Action option to enroll one or more services at a time. You can also Unenroll and Validate the services from the Action option.
    • An Enrolling pop-up shows the enrolling status. Close the Enrolling window when done, and click Next.
  8. A Services page opens with a list of the installed services, along with their service credentials, startup type and current status.
    Any service shown in red indicates that it cannot run as LocalSystem, and requires different service credentials.
    1. Select Credentials under the Actions icon for that service, and supply a valid service Account and Password, and then click Test credentials and OK to continue.
      The Username must be in the form of domain\username and this account should have Administrator privileges on all machines on the network running Equitrac services.
    2. Once all the credentials have been provided, Start all the services, and click Next.
    The DBM Service requires ownership of the OM database. When the service is started, the Configuration Assistant tries to determine if the credentials used for the DBM Service has access to the DBM database and is a database owner. You may see a warning message if the DBM does not have database ownership rights or if the Configuration Assistant user does not have rights to verify the database credentials for the DBM. The DBM Service will start, but you may need to verify that permission has been granted within the SQL Server for this account.
  9. A Licensing page opens displaying the License Server location and Server ID.
    See Licensing ControlSuite for licensing details.
    1. If you want to change the License Server location, click the Edit icon beside the Server location field to open the Change License Server Location window.
      • Confirm the License Server location is correct. Optionally, you can change the default License Server location.
      • Click the Preview button to auto-create the License server ID. The License Server ID is used to manage your licenses on the Customer Portal. Any licensed features will populate the list.
        TLS 1.2 must be enabled on the License server to ensure a secure connection. If TLS 1.2 is disabled, a licensing error may display.
      • Click Apply.

        An Apply licenses window opens to initialize and update the product licenses. When successful, there is a green check-mark beside each item. Close the Apply licenses window when done

    2. Click the Copy icon on the right of the Server ID to copy this ID to the clipboard. The License Server ID is used to register the server and manage your licenses on the Customer Portal.
    3. Click the Open Kofax Customer Portal link to go to the Customer Portal. Alternatively, open a web browser and enter https://register.kofax.com/serialregistration to access the Customer Portal. See Licensing ControlSuite for licensing details.
    4. Once the licenses have been assigned to this License Server, click Refresh Licenses to update the license.
      • Select Update license online and click Apply to communicate with the License Server to synchronize the changes or updates to the licenses on Customer portal.
      • Select This License Server has no access to Internet to update the license file from the binary downloaded from the Customer Portal, then click Download License Request. Open the License File and click Apply.
    5. Click Next to continue.
  10. A System Administrators page opens displaying the configured administrators. Click Next to continue. You can click the Edit icon beside administrator if you want to modify its settings.
  11. A Launch Applications page opens where you can launch any of the installed ControlSuite applications directly from the Configuration Assistant. Alternatively, you can use the Start menu to navigate to the appropriate ControlSuite product.
  12. Click Close to exit the Configuration Assistant.

Configure DRS - ControlSuite

  1. On the Windows Start menu, select All Programs > Kofax > Device Registration Service > Device Configuration Manager.
  2. Click Yes when prompted to make changes to the computer.
  3. Configure settings on the Service tab as described in the following table:

    Settings Description
    Run service under

    You can run the service under the local system account or a network account. The selected account needs system permissions to run the service. The account proper permission to manage, update and configure the SQL Server database when Windows Authentication is used to connect to the SQL Server.

    Service Actions

    Select the Microsoft Windows service startup type for the Device Registration Service.

    Database Connection

    A database repository stores the configuration options that you specify in Device Registration Service. The repository can reside in Microsoft SQL Server Express or Express LocalDB installed with Device Registration Service, or it can reside on a remote instance of Microsoft SQL Server.

    Select Enable Local Db to use the Express LocalDB.

    Complete step 4 to use a remote instance of Microsoft SQL Server.

    Service Settings

    Device Registration Service requires several ports to be specified for communication between the Web service and Web client. The Web client is the browser that you will use to access Device Registration Service.

    An Access Group should be specified. The access group is a user or group of users who will have access (and permission) to use Device Registration Service.

  4. To use a remote instance of Microsoft SQL Server to host the repository:
    1. Clear the Enable Local DB check box, and then click Properties to open the Connection Properties dialog box.
    2. Configure Microsoft SQL Server settings as described in the following table:
      Settings Description
      Server name

      For the default instance of SQL Server, enter the server name or IP address of the server that is running SQL Server. If you are using a named instance of SQL Server, enter the instance name as well in the format, server_name\instance_name.

      Log on to the server

      Select the type of authentication for connecting to the server. For the selected type, verify that the credentials have permissions to update or create a database on the specified instance of Microsoft SQL Server.

      Connect to a database

      Select an existing database or create one with the latest schema.

    3. Click Test Connection to test the settings.
    4. Click OK if the connection is successful.
  5. On the Security tab, enable TLS on the web service or the web client:

    To create a self-signed certificate:

    1. Select Enable TLS on Web Service or Enable TLS on Web Client.
    2. In the Choose Certificate box, select New Self-Signed.
    3. Enter the certificate information.
    4. In the Certificate Store box, select the appropriate Windows certificate store to use to store the self-signed certificate, that is, Personal.
    5. Press OK to close the dialog.
    6. Press OK or Apply to save changes

    To use an existing certificate from the Windows Certificate Store:

    1. Select Enable TLS on Web Service or Enable TLS on Web Client.
    2. In the Choose Certificate box, click Select from Store.
    3. In the Certificate Store box, select the Windows Certificate Store that contains the appropriate certificate, that is, Personal.
    4. In Certificate, select the certificate to use for the Web Client.
    5. Press OK or Apply to save changes

    To import an existing certificate file into the Windows Certificate Store:

    1. Select Enable TLS on Web Service or Enable TLS on Web Client.
    2. In the Choose Certificate box, click Browse.
    3. In the Certificate Path box, navigate to the location of the certificate file and select the certificate. Press OK.
    4. In the Certificate Password box, type the certificate password.
    5. In the Certificate Store box, select the appropriate Windows certificate store to use to store the imported certificate, that is, Personal.
    6. Press OK to close the dialog.
    7. Press OK or Apply to save changes.
    Saving changes will require a DRS service restart for changes to take effect.
    DRS supports TLS 1.0, 1.1 and 1.2. Support for SSL 3.0 has been discontinued.
    Administrator responsible for the configuration must ensure that the account running DRS service has the necessary access rights to the chosen certificate in the particular Windows Certificate Store to which it is imported or added.
  6. Configure logging settings on the Administration tab as described in the following table:

    Settings Description
    Web Service Logging

    In the Log Path box, type the path to the location where you want to store the web service log file, or click Browse to select the location.

    To generate more detailed log files for debugging and advanced troubleshooting with Support, select the Enable Tracing check box.

    This option may affect Device Registration Service performance. Enable tracing only when it is necessary.

    Click Show Logs to open the log file in a text editor.

    Web Client Logging

    In the Log Path box, type the path to the location where you want to store the web client log file, or click Browse to select the location.

    To generate more detailed log files for debugging and advanced troubleshooting with Support, select Enable Tracing.

    This option may affect Device Registration Service performance. Enable tracing only when it is necessary.

    Click Show Logs to open the log file in a text editor.