Manage Import Extensions (5.X)
- Kelli Higdon
This file describes Switchvox version 8.0 and later. If you are using an earlier version, use SETUP-EXTENSIONS-Manage-Import-Extensions (6.6).
Import Extensions
The Import Extensions tool lets you create and update multiple SIP or Virtual extensions from data in an imported CSV file. To do this, you need an Extension File that is formatted correctly with specific extension information. Then, you can use the Import Extension tool to identify that file, evaluate the extensions that will be created or modified, and perform the import.
The Export Extensions button downloads a file that already defines the headers and contains the data about your existing SIP Phone extensions. If you have not already created any extensions, the file is empty. You can add or modify extension information, and import the file.
The Import Extensions File
The Import Extensions File must be in Comma Separated Value (CSV) format, with the following format:
The first line of the file must be a header line that labels each column. Each subsequent line should be an extension line that contains the values of an extension.
Depending on the type of extensions you are working with (SIP or Virtual) different information is required or accepted. You can use a file that has additional columns of information (Switchvox ignores this information) as long as the required extension information is included correctly.
The order of the labels in the header is not important, but the values of each extension must match the order of the labels.
If you are updating an existing extension and you have some information that you do not want to change, use just the comma with no spaces or text. If you want to make it blank, put a space in that column.
If you have set Switchvox to LDAP mode (Setup > Extension Settings), the header-line must include the label username. Values for username are not required in each extension-line, but the label must be in the header. For examples of a CSV file with username, see Switchvox with Active Directory and LDAP.
When your Extension File is ready, go to Setup > Extensions > Manage and click Import Extensions (see “Import Options”).
File Information
This table describes the data for each type of import:
| ext | fname | lname | login_email | title | location | password | voicemail_password | phone_password | digium_phone_mac_address | |
|---|---|---|---|---|---|---|---|---|---|---|---|
SIP: New | x | x | x | x | x | A | A | x | x | A | A |
SIP: Update | x | A | A | A | A | A | A | A | A | A | A |
Virtual: New | x | x | x | x | x | A | A | x | x | NA | NA |
Virtual: Update | x | A | A | A | A | A | A | A | A | NA | NA |
x = REQUIRED ::: A = ACCEPTED ::: NA = NOT USED
File Examples
SIP Extension File
ext,fname,lname,login_email,email,password,voicemail_password,phone_password,digium_phone_mac_address
100,Joe,Smith,jsmith@home.com,jsmith@home.com,!@#$12As,1000,,0019159C0646
101,Jane,Doe,jdoe@home.com,jdoe@home.com,!@#$12As,1010,,0013174C5532
102,Dan,Jackson,djackson@home.com,djackson@home.com,!@#$12As,1020,,Virtual Extension File with location and other information
fname,lname,login_email,email,dept,ext,password,voicemail_password,location,phone_password
Joe,Smith,jsmith@home.com,jsmith@home.com,sales,!@#$12As,100,1000,3A,
Jane,Doe,jdoe@home.com,jdoe@home.com,sales,!@#$12As,101,1010,3B,
Dan,Jackson,djackson@home.com,djackson@home.com,facilities,!@#$12As,102,1020,9A,SIP Extension Updates File without passwords with a location
ext,fname,lname,email,password,voicemail_password,phone_password,location
100,Joe,Smith,jsmith@home.com,jsmith@home.com,,,,2A
101,Jane,Doe,jdoe@home.com,jdoe@home.com,,,,3B
102,Dan,Jackson,djackson@home.com,djackson@home.com,,,,2C
Import Options
The Import Extensions options determine how to manage this import. When the settings are correct, click Evaluate Import to evaluate the Extension File and to see what will happen if you import the file.
Extension File. Browse your machine to find your Extension File. For details about creating this file, see “The Import Extensions File."
Extension Type. This is the extension type that is used for all of the extensions that are created.
Extension Template. This is the Extension Template that is used to create or update all of the extensions. All of the values in the template are used for each of the extensions in the Extension File.
On Duplicate Extension. This option specifies how to respond when an extension in the Extension File already exists on the system.
Skip: Do nothing with the extension data in the file, and skip to the next extension in the file.
Delete and Recreate: Delete the existing extension in the system, then create the extension with the values from the file and the chosen extension template. NOTE: only SIP, Analog and Virtual extensions are affected by this. For example, if you have a Call Queue extension of 333 and have a line in your file to create an extension of 333, this line in the file is skipped even if you have Delete and Recreate chosen.
Update Information: Update the existing extension with the values from the file and the chosen extension template. NOTE: the update is only applied if the extension types are the same. For example, if you have an existing Virtual extension of 100 and have a line in your file to create a SIP extension of 100, this line in the file is skipped even if you have Update Information chosen.
Import Extensions Evaluation
When you click Evaluate Import, Switchvox opens your Extension File and evaluates it against the extensions that already exist.
The results are shown with how many extensions will be created, how many are duplicates, what will be done with those duplicates, and how many are invalid and cannot be created.
If you have invalid extensions, check your Extension File for formatting problems or errors. Be sure your extension numbers are the same length as specified in Setup > Extensions > Settings.
If you want to proceed with the import, click Yes, Process Extensions.