FXS 16-port Card - Batch Upload Guide

Configuring a large number of FXS 16-port Card extensions

After logging into each of your FXS 16-port cards and setting the basic System level parameters identified in FXS 16-port Card - System Menu and FXS 16-port Card - IP Addressing, you must begin the process of creating SIP extensions on both the UCX software as well as the corresponding SIP accounts on the FXS 16-port cards, and map those accounts to the physical ports on the cards.

The default settings for the UCX SIP extensions and the FXS 16-port card SIP accounts are compatible, so a number of time saving capabilities exist in both the UCX software and the FXS 16-port card.

Step ONE: Create .csv file of SIP account details required for UCX batch upload

The UCX software has an upload tool for batch configuration of SIP extensions. The procedure for building the file to upload this information is documented in Batch of Extensions.

There are numerous fields described in the referenced document, including call waiting, voicemail details, various group settings (Callgroup and Pickupgroup), and recording settings. Please review that document if you wish to include those details for your analog extensions. (The refenced document shows how to download the current extensions to a csv file which could then be used as a template.)

The entries used in this example will be ​Display Name, User Extension, Outbound CID, Call Waiting, Secret, Voicemail Status, Voicemail Password, Context, Tech.

  1. Create a spreadsheet with the the headers show above in the first nine columns as a minimum. (The full list of configurable parameters is documented in Batch of Extensions.)
  2. In the Display Name column, enter the name planned to be used for each extension (eg. Room 201)
  3. In the User Extension column, enter the extensions associated with those names (eg. 201)
  4. In the Secret column, enter a password that will be used for each extension. E-MetroTel recommends avoiding Weak Secrets. (eg. ThisIsASecret201B)
  5. In the Outbound CID column, enter the extensions planned Outbound CID in the same format as the carrier will require. This field is optional as in certain facilities such as senior housing, the user's CID may not be known at the time of configuration.
  6. In the Call Waiting column, enter ENABLED or DISABLED based on your requirements for that extension. (eg. ENABLED)
  7. In the Voicemail Status column, enter enabled or disabled based on your requirements for that extension.(eg. enabled)
  8. In the Voicemail Password column, enter your desired password for that extension's access to voicemail.(eg. 829201 if following standard UCX practice)
  9. In the Context column, enter from-internal
  10. In the Tech column, enter sip
  11. Repeat for each of the analog based extensions you need to create. (you may use standard spreadsheet cut and paste or auto-fill methods to create the data.
  12. Save your file as a .csv file extension (eg. UCX SIP Extensions)

Step TWO: Create a .xlsx file for each of the FXS 16-port cards

The FXS 16-port card has a batch upload mechanism called FXS Batch Binding SIP, which allows the upload of details for each of the 16 SIP accounts required for the analog devices and maps the accounts to specific physical ports on the card.

  1. Create a spreadsheet with no column headers The input will be created in the following format: Physical Port, Extension, Secret, UCX IP Address, Blank Column, SIP Port, VOS Encryption, Priority Codec, Support Codecs
  2. In the first column of the spreadsheet, type the numbers 1 to 16, representing each of the 16 physical ports on the card. If you are not using all 16 ports, then only enter the number of ports you do plan to use.
  3. Copy the first sixteen User Extensions from the previous spreadsheet (UCX SIP Extensions) and paste it into the second column of this spreadsheet (eg. 201 through 308)
  4. Copy the first sixteen Secrets from the previous spreadsheet (UCX SIP Extensions) and paste it into the third column of this spreadsheet. (eg. ThisIsASecret201, etc.)
  5. Enter the IP address of the UCX server card's backplane ethernet interface into the fourth column of this spreadsheet.
  6. Leave the fifth column blank.
  7. Enter the SIP port being used on the UCX (default 5060) into the sixth column of this spreadsheet.
  8. Enter No in the sixth column of this spreadsheet.
  9. Enter G.711u-law into the seventh column of this spreadsheet.
  10. Enter All; into the eighth column of this spreadsheet (you must include the semicolon immediately after the word "All" with no space.
  11. Save your file as a .xlsx file extension (eg. FXS 1 Extensions.xlsx)

Step THREE: Upload the .xlsx batch file to the FXS 16-port cards

It is important that you verify that the UCX either does not have Telephony service enabled under IP Block List (see IP Block List) or that, if it is enabled it excludes (i.e Do Not Block) the UCX server card backplane address range as the SIP accounts on the FXS 16-port card will immediately begin to attempt to register on the UCX.
  1. Navigate to the SIP / FXS Batch Binding SIP page on the first FXS 16-port card
  2. Click Choose File and select the newly created ".xlsx" file (eg, FXS 1 Extensions.xlsx)
  3. Click ImportFXS16BatchBindingSIPImported.png
  4. Click Save
  5. Repeat this process for each of the FXS 16-port cards along with their corresponding ".xlsx" files.

Step FOUR: Upload the .csv batch file to the UCX

It is important that the FXS 16-port cards uploads be completed before the upload of the SIP extensions to the UCX as part of the licensing process.
  1. Navigate to the PBX / Batch Configuration page of the UCX Web-based Configuration Tool.
  2. Select Batch of Extensions from the left hand menu.
  3. Click Choose File and select the ".csv" file containing the entire list of UCX SIP extensions (eg. UCX SIP Extensions.csv).
  4. Click Upload CSV File. The UCX will provide an indication of how many extensions were updated.

Step FIVE: Verify that the ports have registered using Basic licenses

  1. On the FXS 16-port card, navigate to the System / Status page.
  2. In the Port Information table, verify that the Line Status/Sip Account column shows the extensions you intended to assign to each physical Port .
  3. In the SIP Information table, verify that each of the User Name (i.e.extensions) point to the UCX backplane Ethernet address in the Host column, are set to client in the Registration column, show, Registered in the SIP Status column with a Response Code of 200 OK.
Page Tags: