OnCall IVR Engine v3.3.4, part of OnCall IVR Suite v3.3.x

IVR Engine Installation

This document describes the installation steps required to deploy the IVR Engine component of the Geomant OnCall IVR Suite.

Clean Installation

To install the IVR Engine components onto a computer with no previous version of the product, please do the followings:

  1. Login to the IVR Engine host with a user account possessing local administrator privileges.

  2. Navigate to the installer and launch the setup executable file.

  3. Select the destination folder of the installation.

  4. Select the preferred installation method – see description of the different methods below.

  5. Click Install and then Finish to finalize the installation process.

Upgrading an Existing Version

Would you like to install the product to a computer already running a previous version, you must perform the following high level steps:

  1. Stop all components of all instances (on every computer) of the previous version of the IVR Engine components using the Services admin tool in Windows.

  2. Make a backup of the database (by default ucmaivr).

  3. Make a copy of all configuration and license files of the previous version on every IVR Engine server:

    1. Geomant/IVR/EndPoint/UCMAIVR.exe.config
    2. Geomant/IVR/IVRCompSrv/web.conf
    3. Geomant/IVR/IVRWS/web.conf
    4. Geomant/IVR/LSMgr/lic/*.license.signed.xml
    5. Geomant/IVR/NodeService/NodeService.exe.config
    6. Geomant/IVR/Tools/CustomNodeCreator.exe.config
    7. Geomant/IVR/Tools/IVRWSTester.exe.config

  4. Use the Windows Settings / Control Panel to uninstall the previous version of the product entirely from all IVR Engine server hosts. Visit the installation directory (Geomant/IVR on the storage drive of choice) and remove it.

  5. On every IVR Engine server, perform the clean installation of the new version as described in the Clean Installation chapter.

  6. Edit the new config files and manually apply the config settings your deployment needs. Use the previous config files to copy individual values from.

    Note

    Do not copy the old config files over into the new IVR Engine deployment folders. They will not work because the structure of the config files might change in newer versions of the product.

Installed Components

Some IVR Engine components can be installed in multiple copies on multiple different server hosts to provide increased load bearing capacity. The installer application provides the following installation methods:
Full Install Every component is installed onto the designated server host.
Web Services Install Only the web services components are installed under the IIS of the designated server host. These include the Web Services (IVRWS), Component Server and Support Tools components.
Endpoint Only Only the Endpoint Service component is installed.
Support Tools Installs the IVRWSTester application.
Custom Any of the available components can be installed in combination.

Every IVR Engine implementation requires a single instance of the database, Web Service and License Server components. Though a single copy is sufficient most of the times, the Node Service and Endpoint Service components can be deployed in multiple instances.

The installer application configures the installed Windows services to run using the LocalSystem account by default. This can be changed after the installation is complete.

Database Installation

Installing for the First Time

  1. Launch the SQL Server Management Studio and log in to the SQL server designated to host the IVR Engine database ucmaivr using an account with sysadmin privileges.

  2. Locate the IVR\createivrdb.sql file on the installation media and execute it in SQL Server Management Studio. The script should execute without any errors.

  3. Locate the IVR\createivrtables.sql file on the installation media and execute it in SQL Server Management Studio. The script should execute without any errors.

  4. Navigate to the Security Node under the database host's node and expand the Logins tree.

  5. Create a new login by right-clicking on Logins and selecting New Login...

  6. Search for the domain or local user account that was set up to run the Windows Service components.

  7. Specify Entire Directory for the search, enter the user account and click on Check Names to find it.

  8. Click OK when the user account is found.

  9. After selecting the user account, go to the User Mapping tab and check the box next to the ucmaivr database.

  10. Assign db_owner permission from the database roles list below to this new login on the ucmaivr database.

  11. The newly created and assigned login should appear under ucmaivr→Security→Users.

Further details on the Windows Service running user account are described in the Preparing the environment and the Configuration Guide document.

Upgrading the Database for a New Product Version

Even though the application components of an IVR Engine can not be upgraded, the database can. You don't need to uninstall and reinstall it for the new version of the product to work.

  1. Launch the SQL Server Management Studio and log in to the SQL server designated to host the IVR Engine database ucmaivr using an account with sysadmin privileges.

  2. Locate the IVR\createivrtables.sql file in the installation media and execute it in SQL Server Management Studio. The script should execute without any errors. It will deploy any changes to the old database that might be needed for the new version of the product.

Sorry, your browser does not support inline SVG. article updatedarticle updated2/21/2024 3:19:17 PM (UTC)2/21/2024 3:19:17 PM (UTC)