Configure ControlSuite

  1. After installing ControlSuite, launch the 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 check mark 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.

    Note: 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 Test 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 Test to verify the database and server and functioning.

    Note: 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 Test to verify the database and server and functioning. A green check mark displays when validated.
    Note: If you are installing Equitrac 6.0 on a server with an existing Equitrac database, it is recommended that you create a new 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 set up 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 Browse to open the location of stored certificates and select the desired file. Click OK to continue.
        Note: 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.
      Note: 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.
      Note: 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 drop-down 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.
    Note: 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.
      Note: 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.
    Note: 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 License 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.
        Note: 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.
    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.