Desktop Application . XML/SOAP web service interface . Help
Magrathea Interface - Help page


Introduction

This page provides help for setting up and using the Magrathea Interface application. It runs on Microsoft Windows, and requires version 2 of the .Net Framework, which can be downloaded here.

 

1. Installation

To install, run the Setup.msi file by double clicking it, or right click and select Install.

Two files are installed, the executable - MagratheaInterface.exe - and the settings file - Magrathea.Settings. In addition, shortcuts are added to the Windows desktop and Start bar.

Launch the application by clicking Start | Programs | Magrathea Interface, or by double clicking the icon on your desktop.

Before using the application to manage phone numbers, the connection properties must be set, as shown below.


2. Getting connected

All connection details are entered in the Options window. To open the options window, go to the menu at the top of the application and select Tools, then Options.

2.1 Connection

Set the connection details as above, specifying your Magrathea account in Username, and password in Password. Please use capitalization as shown above. Everything apart from MagratheaXmlService should be lower case.

2.2 Entering or importing phone numbers

In the options window, select the numbers field, and a small button will appear on the right hand side (as shown above). Clicking it will open a window where phone numbers can be pasted or entered manually.

2.3 Backing up your settings

Go to the installation folder (by default C:\Program Files\Magrathea Interface), and copy the Magrathea.Settings file to another location. In the unlikely event that the settings file becomes corrupted, it can then be replaced by the last good backup. The settings file should be backed up after every change.

 

3. API replacements


AUTH
and QUIT are controlled by the application. There is no need, nor facility within the application to call these directly.

ALTEN is replaced by the upper pane in the allocation window.

ALLO and ACTI are replaced by the lower pane

STAT is performed by clicking on a number in the numbers list in the status window. Once a status is viewed, then the number can be DEACtivated or REACtivated using the status dropdown, then clicking the Update button. Similarly, destinations can be SET by entering the destination and selecting the correct type from the target dropdowns, then clicking update. To clear a destination, remove the text from the relevant textbox and click Update. INFO can be entered against a number using the Set Info button.

SPIN, FEAT and ORDE functions are currently unavailable.

 

4. How to

4.1 Adding phone numbers to your account

Click on Allocate numbers in the leftmost pane. The allocation view will appear on the right. At this point, you have two choices, you can search for 10 number ranges, or enter the prefix of the number you would like.

4.1.1 Searching for 10 number ranges

  • Enter the prefix of a number, for example, 01353, or 01353634. Do not add underscores as you would in a telnet session.
  • Set the dropdown to the number of digits (11 in this case).
  • Click the Look up button
  • The availability of the range will be displayed below.
  • Clicking the Look up button repeatedly will cycle through available ranges

Each time the Look up button is clicked and returns an available range, the details of the lower half of the allocation pane are automatically completed, ready for allocation.

4.1.2 Allocating and activating numbers

Before phone numbers can be assigned to customers, they must be allocated and activated. These two steps are performed together by the application, so no separate allocation is required.

  • Enter the prefix of a number, or the entire number, for example, 01353, or 01353643, or 01353634634
  • Set the No. of digits dropdown to the number of digits in the phone number to be allocated (11 in this case)
  • Set the Allocate dropdown to the number of phone numbers required - between 1 and 10
  • Click the Allocate button.
  • The success or failure of allocation and activation will be recorded in the list below

Once a number is allocated, it is automatically added to the numbers list and will be visible in the status view.

4.2 Viewing and changing the status of allocated phone numbers

Click on View or change status or targets in the leftmost pane. The status view will appear on the right.

Select any of the phone numbers from the list by clicking on it, or selecting any number, and moving through the list using the arrow keys. The status, activation and multiple destinations of the number will be displayed on the right.

  • Use the Status dropdown to enable (reactivate) or disable (deactivate) the phone number.
  • Use the Target dropdowns to select a target type, and enter the destination beside it.

When setting targets, do not enter the target type in the text box. i.e. select SIP RFC2833 DTMF in the dropdown, and enter the SIP target 0123456789@axal.axtalk.com. Do not prefix this with S: as in the telnet interface.

When all information is updated, click the Update button. Doing so will write all of the information back to Magrathea Telecom. No information is written until the button is clicked, so to restore the values that have been edited, click on the number again in the list, and the live settings will be re-entered.

The Set Info button can be used to enter information against the selected number. Unfortunately, it is write only at present and cannot be viewed.

4.3. Resizing the window

All of the vertical and horizontal breaks can be dragged, or selected using the tab key and changed with the up/down or left/right keys. The breaks are shown in red below:


Error handling


Errors are displayed in the status bar at the bottom of the application.

If the application cannot communicate with the web service, an error message of Unable to reach web service, please check your internet connection will be displayed. If the application successfully connects to the web service, but the web service cannot reach Magrathea, a different error message, The web service was unable to reach www.magrathea-telecom.co.uk is displayed. Other error messages are similar to those from the telnet interface.

All successful calls display a smiley - :) - in the status bar.

An error message of Access denied or AUTHorization required first means that your username and/or password are wrong.