This section describes the steps required to create a fully functional analog extension for the UCX using the GUI interface on both the UCX and the Analog Gateway card.

E-MetroTel advises to configure the UCX extensions prior to configuring the extensions on the FXS card or to add the IP address or subnet of the FXS card in the Telephony to the Do Not Block field of the IP Blocklist capability in the UCX to avoid potentially blocking the card from communicating with the UCX due to failed password attempts.

Refer to E-MetroTel Provisioning Server documentation for the steps to use the No Touch Provisioning Server for configuring both the UCX and Analog Gateway cards remotely.

Prerequisites

UCX

1. The UCX must have an available Basic (or greater) license for each analog extension to be configured.

Gateway Card

1. The Gateway card must be on a network interface that is able to be routed to the UCX software
2. The Gateway card must be activated with the E-MetroTel Serial Management tool.
3. The Gateway card must have one or more unassigned FXS ports available, or you must edit an existing port configuration.

Configuration Overview

Configuration – On the UCX

Refer to Adding a SIP Extension for details on how to configure the UCX SIP extension parameters.

Configuration – On the FXS Gateway card

There are two steps to configuring an analog extension on the FXS gateway card:

1. Configure one or more Profile(s) to that describe the common set of parameters used for communicating to the UCX. Refer to Analog Card – System Menu – Profiles.
2. Configure the FXS Port Settings for each of the SIP User IDs (SIP Accounts) that register on the UCX identified in the selected Profile(s). Refer to Analog Card – System Menu – Port.

FXS Gateway Card – Step 1 – Create a Profile

On the FXS16 (with new firmware) navigate to the Profiles menu item, and select the profile number your wish to use.  (Port 1 in our example.)

SIP Settings

The page opens to the SIP Settings tab. If you make any changes in this tab, you must press Save prior to navigating to another tab or any other menu item.

Basic Settings

1. SIP Primary Server: Enter the IP address of the UCX that will be used for this profile (eg. 192.168.1.224 in this example). Individual FXS ports can be associated with different UCX servers using different profiles).
2. SIP Primary Server Port: Enter the port number used to signaling to the UCX (eg. typically 5060, as in this example). When communicating to a UCX Cloud system this would be port 5960.
3. SIP Backup Server: Leave as default (Empty)
4. SIP Backup Server Port: Leave as default (5060)
5. SIP Address Selection: Leave as default (Default)
6. DNS Mode: Leave as default  (Auto Identification)
7. Outgoing Proxy Server: Leave as default (Empty)
8. From Domain: Leave as default (Empty)
9. Stun: Leave as default (No)
10. Enable Compatibility: Leave as default (No)

Registration Settings

1. SIP Transmission Mode: Leave as default (UDP)
2. Authentication Domain: Leave as default (*)
3. Registration Validity Period(s): Leave as default (3600)
4. Registration Failure Retry Interval(s): Leave as default (30)
5. Registration Failure Retry Times: Leave as default (2147483647)

Heartbeat Settings

1. Disable Qualify Verification: Leave as default (Yes)
2. SIP Heartbeat Sending Frequency (s): Leave as default (No)
3. SIP Heartbeat Timeout (s): Leave as default (No)

RTP Encryption

1. RTP Encryption Mode: Leave as default (Disable)

Certificate Settings

1. Version: Leave as default (Please Select)
2. URl Pattern: Leave as default (SIP)
3. Select the PEM Certificate: Leave as default (None)
4. Select the CA certificate chain: Leave as default (No)
5. UAC verifies paired-end certificate: Leave as default (No)
6. UAS verifies paired-end certificate: Leave as default (No)

Click on Save before continuing.

Digitmap Settings

Navigate to the Digitmap Settings tab. If you make any changes in this tab, you must press Save prior to navigating to another tab or any other menu item.

1. Digitmap Model: Leave as default (Local Priority)
2. Fuzzy Match: Leave as default (Yes)
3. Use # as Send Key: Leave as default (Yes)
4. Dialing Rules: This field can include any specific dial patterns that can be used to shorten the delay before the dialed digits are sent to the UCX. In the example shown, the string 9XX,99XX,*XX,[23]XXX,1XXXXXXXXXX,011. is used.
   1. This means that if the user dials any of the following then the call will be routed immediately.
      • 911 or 9911 (You should include any other explicit emergency number in a similar format.),
      • Any two digit feature code that is configured on the UCX,
      • any 4 digit number that begins with 2 or 3 (if using four digit extensions in the 2000 to 3999 range)
      • any 10 digit number that is preceded by a 1
   2. If the user dials 011 then the FXS port will wait until the end-of-dialing timeout before sending all collected digits to the UCX.

Care must be taken to ensure that the dial plan for the selected Profile matches the overall dial plan requirements for the customer network.

Function Key Settings

1. Query WAN IP: Leave as default (*02)
2. Query LAN IP: Leave as default (*03)
3. Query MGT IP: Leave as default (*04)
4. Query Channel Number: Change to, (if not already set) to *05
5. Query Local Number: Change to, (if not already set) to *06

6. All Function Key: Leave as default (No). This will leave all subsequent entries in the table inactive.
7. Click Save

VOIP Settings

All the VOIP settings can remain at their default values.

Analog Settings

All the Analog settings can remain at their default values. However, if the extension has Voicemail configured on the UCX, the you will want to change

1. Enable MWI: Change to Yes
2. Enable MWI Subscription: Change to Yes
3. Click Save

FXS Gateway Card – Step 2 – Configure FXS Port Settings

There are three different methods that can be used to configure the FXS ports via the Web user interface.

1. Using the Basic Setting, Call Setting, and Advanced Setting tabs for each port on the FXS Port Settings page.
2. Using the Bulk Setting capability on these same tabs
3. Using the Import capability to import the settings from a spreadsheet

It is also possible to use the FXS Provisioning Tool on the E-MetroTel Partner Portal.

Method 1

For each FXS Port that you plan to use, configure using the FXS Port  Basic, Call, And Advanced Settings tabs.

Navigate to the Port / FXS Port Settings page. (Refer to Analog Card – System Menu – Port documentation for more details.)

Basic Settings tab

1. SIP User ID: Enter the SIP Extension on the UCX to be associated with this physical port. (eg. 305 for Port  FXS1 on this card as shown in this example).
2. Authentication ID: can be left blank for typical configurations.
3. Password: Enter the Secret configured for this extension on the UCX (eg. fxs1234 as noted above in the UCX configuration.
4. Username: Enter a username (typically either the extension or the name of the UCX extension) (eg. 305)
5. Profiles: Select the profile you configured previously for this/these extensions. (eg. Profile 1)
6. Enable Port: Ensure that this is set to Yes
7. Enable Registration: Ensure that this is set to Yes
8. Click Save

Call Settings tab

You may leave the settings for the Call Settings tab should all be set to Disabled. However, there are many applications that require analog devices to automatically dial a pre-determined destination (PSTN phone number or extension) some period of time after the phone device has gone off-hook. Examples include telephones at entrance doors or gates, lobby or elevator phones, and emergency phones deployed for public safety. In some cases the dialing is required to be immediate while in others it may be desired to include a delay before the autodial to allow the phone user to enter a different number required. This capability is referred to by multiple terms including Hotline, Autodial, or Ringdown.

If you wish to operate any of the ports as a a Hotline, where a number is automatically dialed some time after the phone has gone off-hook, then for each port where this functionality is required:

1. Hotline Number: Enter the digits you wish to be automatically dialed. These digits must be consistent with the Digitmap Settings previously configured above.
2. Hotline Delay(s): Enter the period of time that must elapse before the digits are sent, in seconds. If a user begins to dial from their telephone before this delay time elapses, then the digits dialed by the user will be sent to the UCX. Note that the digit string for the extensions should match a rule in the Digitmap settings configured for the Profile used for these ports otherwise the standard end-of-dial timeout will need to expire before the digits are sent.
3. Click Save

The following shows two ports configured for Hotline,  When the device connected to Port 1 goes offhook, it will wait 1 second as configured in the Hotline Delay field to detect it the calling party begins dialing a different set of digits. If no new digits are dialed in that first second, the Hotline digits will be used and the call will connect to x765. With a Hotline Delay of 0 seconds, Port 2 will immediately begin dialing the Hotline number of x567.

The corresponding Digitmap settings for the configured profile will look like this with the addition of the XXX string:

Advanced Settings tab

You may leave the settings for the Call Settings tab at the defaults.Depending on the telephone that you are connecting to the port, you may decide to modify the CID Message format from the default setting of Display Name and CID to Display CID Only or to Display Name Only for each port that you are configuring. The click Save.

Advanced Configuration Options

Dial Pulse Configuration

Although it is typically not widely used in many markets today, if the telephone that you are using only supports Dial Pulse for the sending of digits, you must configure the card for Dial Pulse operation in the Advanced Configuration / Analog Settings.

1. Navigate to Advanced Configuration / Analog Settings page in the main Gateway Card menu
2. In the FXS Settings section of the page
   :
   1. Set the Enable Pulse Dialing to Yes (default is No)
   2. Click Save