Configure Output Manager for high availability

The Configuration Assistant walks you through the setup of databases, services, security and authentication, and licensing the ControlSuite solution. The configuration assistant must be completed in order, and as you complete the steps, the navigation menu items becomes "active", and you can click on any completed section to review or make changes as needed.

The following procedure is an overview for configuring Output Manager for high availability only. To configure ControlSuite, refer to Configuring ControlSuite.

  1. 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 component database instances.

    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. Click the edit icon if you need to modify the database.

    A Running Database Scripts window opens to locate and connect to the selected databases. If successful, there should be 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 drop-down 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. If successful, there should be 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 open the desired file. Click OK to continue.
    2. Click Next. A Binding Ports window opens updating the IIS certificates. If successful, there should be 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 port used. Select Start to start the licensing service if it not already running.
    • Click Next.
  6. An Authentication & Security page opens. The information displayed on this page depends on the installed Security Framework components.
    If Security Framework components AA+SSDS+DDB are installed, you can Create Security Admin User credentials for the security admin to have access to configure ControlSuite security registrations, or you can Connect to an Existing Server. These credentials are created when you first install a security framework node, and will be required later.
    • If you create an Admin User, enter the Security Admin Credentials Username and Password and click Apply, and then click Next to continue.
      Note: 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.
    • If you select the Connect to an Existing Server check box, enter the Security Admin Credentials Username and Password associated with that server and click Login and then click Next to continue.
    • You can click the Edit icon beside the Host or Port fields to change its defaults.

      An Initializing Security Framework window opens to update the configuration and register the database. If successful, there should be 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, and choose Enroll from the Choose drop-down 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. Choose one of the following environments - high availability or distributed high availability - to configure:
    High availability environment
    Back-end servers
    1. Select the check box next to Service Name and from the Choose list, click Stop.
    2. Select the OM DMB Service and from the Actions list, click Configure. Enter the HA Name and click HA.
    3. Repeat this step for the OM Output Service and OM Rules Agent Service. Enter the same HA Name as the OM DBM Service and click HA. These services also use the same DBM Server name as the OM DBM Service.
      Note: These protocols are set to Net.TCP only.
    4. Select the OM DBM Service, OM Output Service, and OM Rules Agent Service and from the Choose list, click Start.
    Front-end servers
    1. Select the check box next to Service Name , and from the Choose list, click Stop.
    2. Select the OM Input Service and from the Actions list, click Configure. Enter the HA Name and click HA. Repeat this step for the OM SNMP Service. These services must use the same HA name as the services for the back-end server.
    3. These services must also be on a different DBM Server than the OM DBM Service, OM Output Service, and OM Rules Agent Service.
      Note: These protocols are set to Http or Https only.
    4. Select the OM Input Service and OM SNMP Service and from the Choose list, click Start.
    Distributed high availability environment
    Back-end servers
    1. Select the check box next to Service Name and from the Choose list, click Stop.
    2. Select the OM DMB Service and from the Actions list, click Configure. Enter the HA Name and click HA and Distributed HA.
    3. Select the OM DBM Service and from the Choose list, click Start.
    Front-end servers
    1. Select the check box next to Service Name and from the Choose list, click Stop.
    2. Select the OM Input Service and from the Actions list, click Configure. Enter the HA Name and click HA and Distributed HA.
    3. Repeat this step for the remaining services: OM Output Service, OM Rules Agent Service, and OM SNMP Service. These services must use the same HA Name as the OM DBM Service.
    4. If needed, change the DBM Server name and select Http or Https as the Com Protocol.
    5. These services must be on a different DBM Server than the OM DBM Service.
    6. Select the OM Input Service, OM SNMP Service, OM Output Service, and OM Rules Agent Service and from the Choose list, click Start.

    See Configure Output Manager with SAP in a high availability environment.

  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.
      • Click Apply.

        An Apply licenses window opens to initialize and update the product licenses. If successful, there should be 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 Kofax 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. Open the License File and click Apply.
    5. Click Download License Request if the License Server has no Internet access.
  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.