SQLphone developer site home page

---

SQLphone Runtime as a Service

This guide explains how to run SQLphone Runtime as a Windows service on Windows 2000/XP/2003/Vista/2008.

• This guide assumes you have already setup SQLphone Runtime to successfully handle calls,
  when running as a desktop application, launched from the Windows start menu
• This guide assumes you have installed SQLphone Runtime version 6.0 or higher

1. Setup SQLphone Runtime

You must setup SQLphone Runtime to:

• Auto-start phone lines
• Silently stop phone lines
• Delay whilst Dialogic service starts-up

Proceed as follows:

• Start SQLphone Runtime from the Windows Start menu
• Stop the phone lines if they are currently running (menu > system > stop)
• Select menu > phone > settings
• Tick the 'Auto-start phone lines' option
• Un-tick the 'Ask user to confirm line closure' option
  (this allows the SQLphone Runtime service to shutdown silently, without user confirmation)
• Set 'Wait for Dialogic service to start' to 120 seconds
  (after a Windows re-boot, this gives the Dialogic service plenty of time to start, before starting SQLphone Runtime)
• Press OK and Exit SQLphone Runtime

2. Setup Service Application

Download service files:

• Create a new folder to store service application files, we suggest C:\XYNTService
• Download this file and unzip to C:\XYNTService
• Edit the XYNTService.ini file, check that the CommandLine and WorkingDir paths are correct
• Open a command prompt window (as Administrator under Vista/2008), and type the following:
• cd \xyntservice       (goto service files folder)
• xyntservice -i        (install the service)

Control Panel Service Applet:

• Open the Windows Control Panel, Services Applet
• Scroll down to the SQLphone Runtime service
• Double-click the service to view its properties
• Select the 'Log On' tab, then select 'This account' option.
• You MUST specify the same user/password that you were logged-in as,
  when you setup SQLphone Runtime (step 1 above); logon as LocalSystem will not work

3. Start the Service

Proceed as follows:

• Open the Windows Control Panel Services Applet
• Start the service
• Wait 120 seconds for the phone lines to start (Dialogic startup delay)
• Check that SQLphone Runtime is handling calls correctly

Note: for a logged-in user, there is no visible indication that SQLphone Runtime is running, other than log files being written to. We intend to provide a 'tail' utility so that users can view log progress.

Do not attempt to run SQLphone Runtime from the Windows start menu; it will crash (we are currently are trying to resolve this problem), However, this will not affect the operation of the instance of Runtime that's running as a service.

4. Stop the Service

You must stop the service if you want to make configuration changes or reload new flowcharts.

• Open the Windows Control Panel Services Applet
• Stop the service
• You can now run SQLphone Runtime from the Windows start menu to make configuration changes or reload new flowcharts
• Use the Control Panel Services Applet to re-start the service

5. Emergency Stop

If the service cannot be stopped (step 4 above), you can force exit as follows:

• Open a command prompt window and type the folloiwng to kill the SQLphone Runtime process:
• taskkill /F /IM runtime.exe    (Windows XP/2003/Vista/2008)
• kill runtime.exe               (Windows 2000)
• You can now run SQLphone Runtime from the Windows start menu to make configuration changes or reload new flowcharts
• Use the Control Panel Services Applet to re-start the service

6. Uninstall the Service

It's unlikely you'll want to do this.

• After stopping the service (step 4 above), open a command prompt window and type the following:
• cd \xyntservice       (goto service files folder)
• xyntservice -u        (uninstall the service)
• Reboot Windows to complete service removal

Last updated September 2009