Connector Windows Service

Installation

This install script will install connector as Windows service which will be running under virtual Windows account NT Service\\2Ring [instanceName] [connectorName]. Script will also assign this account all required rights and permission needed for this service to run.

Navigate to the connector installation package and run install.ps1 as Administrator.

Use a non-core version of the Powershell (e.g Powershell 5.1).

Through the whole installation process, you can accept default values in parentheses by pressing Enter.

  1. Enter the 2Ring DW application instance name.

    ../_images/connector-installation-1.png
  2. Enter the connector name.

    ../_images/connector-installation-2.png
  3. Enter the name of the database that will be used by connector.

    ../_images/connector-installation-3.png
  4. Enter the server address of the SQL server.

    ../_images/connector-installation-4.png
  5. Choose whether an integrated security should be used when installing the database.

    • If “Yes” is chosen, windows credentials are used for the installation purpose.

    • If “No” is chosen, an Administrative database user and a password has to be provided. This user is used for running the installation.

      These credentials are only used during the installation process and are not stored anywhere.

      The SQL Server login must have sysadmin rights.

    ../_images/connector-installation-5.png
  6. Choose whether SQL certificate should be trusted.

    If you choose not to trust the SQL certificate, make sure that it is located in the Trusted Root Certification Authorities folder on the system the installation script is running from.

    ../_images/connector-installation-6.png
  7. Choose whether to use an additional connection string settings for a database connection.

    • If “Yes” is chosen, define the additional connection string settings.

    ../_images/connector-installation-7.png
  8. In case when a connector database does not exist yet, choose whether you want to install the database or skip this step.
    In case when a connector database already exists, choose whether you want to upgrade the database or skip this step.

    The script automatically detects if the connector database exists.

    ../_images/connector-installation-8.png

If “Install” is chosen:

  1. Enter a database user for the connector. This user is used by the connector to connect to database during runtime.

    The password for the user is auto generated and will be listed in the installation summary after the connector is successfully installed.

    ../_images/connector-installation-9.png
  2. Enter the ODBC data source name for the primary UCCX server.

    ../_images/connector-installation-10.png
  3. Enter the username of an Informix database user used to connect to the primary DB_CRA database.

    ../_images/connector-installation-11.png
  4. Enter the password of the Informix database user.

    ../_images/connector-installation-12.png
  5. Enter the ODBC data source name for the secondary UCCX server.

    If secondary server does not exist, use the default value of –UNDEFINED–

    • If non-default value is entered:

      1. Enter the username of an Informix database user used to connect to the secondary DB_CRA database.

      2. Enter the password of the Informix database user.

    ../_images/connector-installation-13.png
  6. Enter the ID of the profile in UCCX (in most cases it is 1).

    ../_images/connector-installation-14.png
  7. Enter the version of the UCCX.

    The version has to be in MAJOR.MINOR format. E.g. 11.5.

    ../_images/connector-installation-15.png
  8. Confirm previously entered values by pressing Enter.

    ../_images/connector-installation-16.png
  9. Choose whether a connector service should be installed.

    Before proceeding with the installation of the connector service, the connector needs to be imported via the Administration Tool (see DW Administration Tool Guide -> Connectors -> Installation). Once the connector is successfully imported, fill in the Connector Settings.

    ../_images/connector-installation-17.png
    • If “Yes” is chosen:

      • Enter the directory where the 2Ring DW application is installed.

        ../_images/connector-installation-18.png
      • Enter the API URL of the 2Ring DW application instance.

        ../_images/connector-installation-19.png
  10. Enter the API key of the 2Ring DW application instance.

    ../_images/connector-installation-20.png
  11. UCCX connector Windows service has been successfully installed.

    ../_images/connector-installation-21.png

Post-Installation Steps

To ensure that Queue Real Time statistics display correct values, additional settings must be configured on the UCCX.

  • Navigate to UCCX Administration and under Tools, click Real Time Snapshot Config (see Figure 7)

  • The following properties must be set:

    • Data Writing Enable – true

    • Data Writing Interval – 5

    • Cisco Unified CCX CSQs Summary – true

    • Server Name – comma-separated list of Uccx IP addresses (e.g. 10.10.10.10, 10.10.11.10)

  • Click Update

Figure: Real Time Snapshot Configuration

../_images/connector-installation-snapshot.png

Running connector via command prompt

The connector can also run via the command line. To run the connector in the command line, open it and navigate to the connector deploy folder and run the following command:

ConnectorHost.exe --connector=Uccx

Never run more than one instance of the same connector simultaneously, or the data may get corrupted. It is recommended to use the Windows service in a production environment and only use the command line mode for troubleshooting purposes. Do not forget to stop the service before running the command line mode.