Top

Information to Know Before Starting

Before starting to use these configuration notes, complete the following table to make sure you have the required information to complete the different steps.

Note: The Mediatrix unit must be reinitialised to its factory default settings to make sure the configuration can be successfully executed. The SipProxy service requires a licence.
IMPORTANT: If you perform this configuration note after customising the Mediatrix unit, for example after configuring a custom SIP gateway, all customised parameters will be lost. If you need to perform more that than the configuration described in this configuration notes, start by this one, then move to the other required configuration.
Information Value Used in Step
IP address at which the Web interface of your Mediatrix unit can be reached.
  • If your computer is connected to the unit secondary Ethernet port, i.e. Eth2 on most devices
 Use this value 192.168.0.10 Logging on to the Mediatrix Unit Web Interface
  • If your Mediatrix unit is configured to use a DHCP server, use the DHCP server- provided IP address.
Logging on to the Mediatrix Unit Web Interface
Static IP address as defined in your network address range. Configuring the Uplink Network Interface to a static IP address
Address of each SNTP server. Configuring the SNTP Server to a Static IP Address
Static Default Router IP address for the Uplink Network Interface. Configuring the Default Network Gateway to a Static IP Address
IP address of each DNS server. Configuring the Domain Name Server (DNS)
MAC address of unit Locating the MAC Address of Your Mediatrix Unit
SIP Server IP Address or FQDN of the SIP server Configuring the Default SIP Servers
IP address or FQDN of server to monitor Configuring the SipProxy Service
Sip Proxy licence key Activating a Licence Using the Web Interface
Top

Short_Dialing Transformation Rule

The Short_Dialing transformation rule allows using short extension numbers when in survivability mode, instead of dialing the full destination number.

For example, to transform extensions 1100-1199 into 18885551100-99, it is possible to set the Criteria to (11..) and the Pattern to 1888555\1. However, if it is left to the default values, the rule has no effect since it tries to match a phone number that contains "XXXX".

Top

Survivability with PSTN Fallback for Cloud Based SIP Services - DGW 2.0 SipProxy Survivability

This use case describes the configuration of an office when the Mediatrix unit is located in the LAN. It implies that:
  • When the Hosted SIP service fails, internal calls go through the SipProxy.
  • When the Hosted SIP service fails, PSTN calls go through the SipProxy, and are internally routed to the telephony interfaces.
  • In survivability situations, when the Hosted SIP services comes back online, the Mediatrix unit must wait for a REGISTER to go through before sending the calls to the SIP trunk.
  • The Mediatrix unit is located in the LAN, behind a Near-End NAT.


Top

Logging on to the Mediatrix Unit Web Interface

Before you begin
The computer IP address must be in the same TCP/IP network as the Mediatrix unit.
About this task
For better performances, it is recommended to use the latest available version of Microsoft Internet Explorer, Google Chrome, or Mozilla Firefox.
Note: You may not be able to log on to the Mediatrix unit Web interface if you are using older browser versions.
Procedure
  1. In your Web browser, enter the IP address at which the Web interface of your Mediatrix unit can be reached.
    • If your network has an IPv4 DHCP server, connect the primary Ethernet port of the Mediatrix unit to the network (ETH1 port), use the provided DHCP server IP address.
    • You can also connect your computer to the secondary Ethernet port of the Mediatrix unit (ETH2), use the 192.168.0.10 IP address. However, the computer must also own an IP address in the 192.168.0.0/24 network.
  2. Enter admin as your username and administrator as the password.
    Note: You can also use public as a username and leave the password field empty; it has the full administration rights by default.
  3. Click Login.
Results
The Information page of the Web interface is displayed.
Top

Locating the MAC Address of Your Mediatrix Unit

About this task
The MAC address of the unit is:
  • printed on a label located under the Mediatrix unit
  • displayed in the Current Status table of the Web Interface (System/Information)
Top

Activating a Licence Using the Web Interface

Before you begin
You must have received the licence key for your specific unit .
Steps
  1. Go to System/Information.
  2. In the Activate Licence table, enter your licence key.
    Note: A licence key is generated for one specific unit only, therefore it cannot be used on another unit.
  3. Click Apply.
  4. Validate that the Licences table now displays the Survivability Licence, with the correct number of users.
  5. At the top of the screen, restart required services.
Result


Top

Setting the Automatic IPv4 Configuration to the Uplink Network Interface

Steps
  1. Go to Network/Host.
  2. In the Automatic Configuration Interface table, select Uplink from the selection list located on the same line as Automatic IPv4 config source network.
  3. Click Apply.
Result
The unit will use the Uplink interface for all SIP Signaling.

Top

Configuring the Default Network Gateway to a Static IP Address

Steps
  1. Go to Network/Host.
  2. In the Default Gateway Configuration table, from the IPv4/Configuration Source selection list, select Static.
  3. In the IPv4/Default Gateway field, enter the IP address used as the Static Default Router for the Uplink Network Interface.
  4. In the Default Gateway Configuration table, from the IPv6/Configuration Source selection list, select Static.
  5. In the IPv6/Default Gateway field, enter the IP address used as the Static Default Router for the Uplink Network Interface.
  6. Click Apply.
Result
The specified address is used as the current default router address.

Top

Configuring the Domain Name Server (DNS)

Before you begin
Although it is possible to use public DNS servers you should always ask your internet service provider to provide at least the primary and secondary DNS servers.
Steps
  1. Go to Network/Host.
  2. In the DNS Configuration table, form the Configuration Source selection list, select Static.
  3. For each DNS used, enter the IP address of the DNS.
  4. Click Apply.
Result


Top

Configuring the SNTP Server to a Static IP Address

Before you begin
Make sure there is an SNTP server available.
Steps
  1. Go to Network/Host.
  2. In the SNTP Configuration table, from the Configuration Source selection list, select Static.
  3. Provide an IP address or domain name and port numbers for each SNTP server you are using.
    Note: The best practice is to use the servers supplied by your Internet Service Provider, then complement with servers from a different network close to your geographical area. For example: time.nist.gov (USA), ntp4.sptime.se (Sweden), time1.isu.net.sa (Saudi Arabia), ntp.nict.jp (Japan), time.google.com (Worldwide), pool.ntp.org or one of their regional server pools (see https://www.ntppool.org/ for more information).
  4. If necessary, change the value of the Synchronisation Period.
  5. If necessary, change the value of the Synchronisation Period on Error.
  6. Click Apply.
Result
The SNTP host name and port will be displayed in the Host Status table under Network/Status.

Top

Configuring the Uplink Network Interface to a static IP address

Steps
  1. Go to Network/Interfaces.
  2. In the Network Interface Configuration table, from the Link selection list located next to Uplink, leave the default value, i.e. ETH1.
  3. From the Type selection list, select IpStatic (IPv4 Static).
    Note: The Uplink Network Interface must be set with a fixed public IP address for the NAT/router to be able to do port-forwarding to the unit. It will also be easier for the PBX to communicate with the unit if the address is static.
  4. In the Static IP Address field enter the assigned static IP address.
  5. From the Activation selection list, select Enable.
  6. Click Apply to apply all changes to the configuration.
    Note: Once the changes are applied, the connection with the unit might be lost. You may need to reconnect to the Web page using the new address.
Result
The unit can be reached (via the Web) through the Uplink static IP address

Top

Configuring the FXS Endpoints Registration

Configuring the Default SIP Servers

Context
In some instances, the configuration of the default servers may already be completed.
Steps
  1. Go to SIP/Servers.
  2. In the Registrar Host field, indicate the server IP address or FQDN of the SIP Registrar server .
  3. In the Proxy Host field, indicate the server IP address or FQDN of the SIP Proxy server.
  4. In the Messaging Server Host field, indicate the server IP address or FQDN of the Messaging server, if needed.
  5. Leave the Outbound Proxy Host field empty, unless specifically instructed to set a value.
    Note: Setting the address to 0.0.0.0:0 or leaving the field empty disables the outbound proxy host.
  6. Click Apply.
  7. Located at the top of the page, click restart required services.
Result


Top

Registering Endpoints to the Default Gateway

Steps
  1. Go to SIP/Registrations.
  2. For each endpoint requiring authentication, repeat steps 3 and 4 .
  3. From the Register selection list, select Enable.
  4. From the Gateway Name selection list, select Default.
  5. Click Apply and Refresh.
Result


Top

Setting the SIP Authentication

Steps
  1. Go to SIP/Authentication.
  2. Click Edit All Entries.
  3. In the Authentication table, enter the credentials for each port.
  4. Click Apply and Refresh Registration.
  5. Validate if endpoints are registered. (SIP/Registrations).
Result


Top

Setting Auto-Routing to Use SIP Usernames

Context
This task is mandatory if the registration username is a string, not only numbers.
Steps
  1. Go to Call Router/Auto-Routing.
  2. From the Auto-Routing selection list, select Enable.
  3. From the Criteria Type selection list, select SIP Username.
  4. Click Apply.
Result


Top

Configuring the LAN SIP Clients to Operate without the Mediatrix Unit

Steps
  1. Set the SIP server, username and password according to the Cloud Based SIP Service configuration.
    Note: At this step, these SIP clients do not use the Mediatrix unit to communicate with the Sip Server.
  2. Validate that the SIP clients are correctly registered.
  3. Make calls between all SIP clients in the LAN.
Result
The calls should be routed between the SIP clients, and all available services should work. At this point, the first part of the configuration of this use case is completed.
Top

Starting and Configuring the Survivability SipProxy

Executing the SipProxy Configuration Script

Steps
  1. Go to Management/Configuration Scripts.
  2. In the Execute Scripts table, from the Suggestion selection list, choose Survivability.cfg.
  3. From the Transfer Protocol selection list, make sure that File is selected.
  4. Click Apply and Execute Now.
    Note: The script may take some time to execute. A message to restart the service may be displayed, but it can be ignored.
  5. Wait about 30 seconds for the script to be completely executed, then refresh the page.(F5).
  6. Go to Management/Configuration Scripts
  7. In the Scripts Status Execute table make sure Current State is displaying Idle and Last Result Success.
Result
The survivability configuration script will be executed from the unit file management system, and the values specified in the script will be applied to the running configuration. The survivability proxy is now activated on the unit.

Top

Configuring the SipProxy Service

Steps
  1. Go to SIP Proxy/Configuration.
  2. In the Monitoring section of the Configuration table, in the Interval field, enter the interval at which monitoring requests are sent to verify the SIP server status, in seconds.
  3. In the Toggle Delay field, enter the delay before reporting a status change of the monitored destination, in seconds.
  4. In the Destination field, enter the server IP address or FQDN to monitor.
    Note: In most cases, this will be the Registrar Host.
  5. In the Keep Alive Error Code field, list the response codes (comma-seperated) that indicate that the server is down.
    Note: To detect that the server is down, use the error codes the server will return when it is not available. This will be much faster than using the timeout.
  6. In the Outbound Proxy Host field, if required by your SIP provider, enter the IP address or FQDN of their outbound proxy.
    Note: This parameter was added in firmware version 45.3 for TCP and TLS transports only. UDP will be supported in a later release.
  7. Click Apply to apply all changes to the configuration.
  8. Located at the top of the page, click restart required services.
Result


Top

Modifying the Short Dialing Transformation Rule

Context
If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.
Note: This task is optional.
Steps
  1. Go to SIP Proxy/Routing.
  2. In the User Transformations table, at the right of the Short_Dialing row, click .
  3. In the Configure User Transformation table, modify the Criteria and Pattern fields as required.
    Note: The Short_Dialing transformation rule allows using short extension numbers when in survivability mode, instead of dialing the full destination number. If it is left to the default values, the rule has no effect since it tries to match a phone number that contains "XXXX"
  4. Click Save.
  5. Click Apply to apply all changes to the configuration.
Result


Top

Configuring the Outbound SIP Proxy for the LAN SIP Clients to Send the SIP Traffic to the Mediatrix Unit

Context
These steps must be performed on each LAN SIP clients.
Steps
  1. Set the Outbound SIP Proxy server to the Mediatrix unit IP address.
  2. Validate that the SIP clients are correctly registered.
  3. Make calls between all SIP clients in the LAN.
Result
The Mediatrix unit will now route the calls between SIP clients, and all available services should work. Under SIP Proxy/Registration Cache, in the Registration Cache Search Results table, and each registered user should be displayed in the AoR field.
Top

Enabling the PSTN survivability routes

Executing the Survivable Trunks Configuration Script

Context
If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.
Steps
  1. Go to Management/Configuration Scripts.
  2. In the Execute Scripts table, from the Suggestion selection list, choose Survivable_Trunks.cfg.
  3. From the Transfer Protocol selection list, make sure that File is selected.
  4. Click Apply and Execute Now.
    Note: The script may take some time to execute. A message to restart the service may be displayed, but it can be ignored.
  5. Wait about 30 seconds for the script to be completely executed, then refresh the page.(Ctrl F5).
  6. Go to Management/Configuration Scripts
  7. In the Scripts Status Execute table make sure Current State is displaying Idle and
  8. Make sure the Last Result field is displaying either
    1. Success for C7 units with 8 FXO ports, or
    2. Transfer succeeded but failed to execute completely for all other type of units.
Result
The survivable trunks configuration script will be executed from the unit's file management system, and the values specified in the script will be applied to the running configuration.

Top

Customising the FXO Automatic Calls

Context
If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.
Note: This task is not mandatory. The Survivable Trunks script executed in the previous step sets all FXO ports to automatically call the same destination, this procedure explains how to customize the destination on one or multiple ports, for inbound PSTN calls. The default is to use a special number "88888", which will be redirected in a later step to a Target Extension (for example the main reception).
Steps
  1. Go to Telephony/Services.
  2. From the Select Endpoint drop-down menu, select a specific FXO endpoint.
  3. To change the default configuration of the Endpoint Specific, select Yes.
    Note: Often, in order to configure a blank field, you must first enable the previous field.
  4. In the Automatic Call section, complete the fields as required.
  5. Click Apply.
Result


Top

Modifying the Target Extension Transformation Rule

Context
If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.
Steps
  1. Go to SIP Proxy/Routing.
  2. In the Target_Extension row, at the User Transformations table, click .
  3. In the Configure User Transformation table, modify the Pattern field as required.
    Note: The Target_Extension transformation rule allows forwarding any PSTN inbound call to a specific internal extension, usually the main reception. By default all incoming calls are tagged to the special number "88888", the transformation replaces that number by the target extension number, in order to forward those calls properly.
  4. Click Save.
  5. Click Apply to apply all changes to the configuration.
Result


Top

Configuring the Survivability PSTN Outbound Route

Context
If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.
Note: This task is not mandatory. Any dialed destination, other than an internal registered number, will be sent to the PSTN route when in survivability mode.
Steps
  1. Go to SIP Proxy/Routing.
  2. In the Routes table, click located on the last route.
  3. In the Configure Route table, modify the Criteria field.
    Note: there is no selection criteria by default, if a specific PSTN prefix is required then a valid regular expression has to be set, examples: 9[2-9].….….$, or 00.$ if the Remove_PSTN_Prefix transformation had to be modified to use the 00 prefix to access the PSTN.
  4. In the Target UserTransformations field, select the transformation you want to associate.
  5. Click Save.
  6. Click Apply to apply all changes to the configuration.
Result


Top

Modifying the PSTN Prefix Transformation Rule

Context
If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.
Steps
  1. SIP Proxy/Routing.
  2. In the Remove_PSTN_Prefix row, at the User Transformations table, click .
  3. In the Configure User Transformation table, modify the fields as required.
    Note: By default the Remove_PSTN_Prefix transformation rule removes the first digit from the destination number, when prefixed by 9 only. An alternate configuration, popular in Europe (strip the leading two digits 00) would be to set the Criteria to "00(.+)".
  4. Click Save.
  5. Click Apply to apply all changes to the configuration.
Result


Top

Performing a Configuration Backup to the Unit File Management System

Steps
  1. Go to Management/Backup and Restore.
  2. In the File Name field, indicate the name of your backup.
    Note: The file name is case sensitive. As a best practice, add the .xml extension. Make sure to indicate the firmware version the backup was made from because a backup file can not be restored on an older firmware version than the one it was taken from.
    Note: Remember, if you have several units with several configurations and plan to reuse the configuration on another unit, the name must be explicit. Indicate the date of your backup, the interfaces used, the device model, etc.
  3. From the Transfer Protocol selection list, select File.
  4. From the Content selection list, choose the elements you wish to include to the backup.
  5. If you wish to use encryption for backup operations, complete the Privacy Parameters.
    Note: Media5 corp strongly recommends to use a privacy algorithm (encryption) to protect certificates and passwords.
  6. Click Apply and Backup Now.
Result
The configuration will be saved in the unit file management system. The backup file will appear at the end of the list of the File page, under Management/File.

Top

Online Help

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.

Top
Top

Copyright Notice

Copyright © 2023 Media5 Corporation.

This document contains information that is proprietary to Media5 Corporation.

Media5 Corporation reserves all rights to this document as well as to the Intellectual Property of the document and the technology and know-how that it includes and represents.

This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever, without written prior approval by Media5 Corporation.

Media5 Corporation reserves the right to revise this publication and make changes at any time and without the obligation to notify any person and/or entity of such revisions and/or changes.