Migrating from Elastix 2.5/4.0 to Elastix 5
On this topic
In order to help you migrate to the new Elastix 5, we made an open source converter to convert your existing backups from Elastix v2.5 or v4.0 to an Elastix 5 configuration that you import into a new installation. The converter runs as an online service (https://converter.elastix.org) - you upload your backup and then download your Elastix 5 configuration.
Step 1: Take a backup in Elastix
To take a Backup on Elastix v2.5 or v4, login into the server as an administrative user and click on the System tab on the menu, then click on “Backup/Restore” and “Perform a Backup” as shown below:
Before taking a backup in Elastix, you need to check the minimum following options and then click on “Process”:
- Endpoint, Select All
- Asterisk, Select All
- Others: Mysql Database
- Others: Menus and permissions
Once the Backup is completed for example “Backup Complete!: elastixbackup-20161213051540-s3.tar” click again on “Backup/Restore” to list the new Backup and download it by clicking on it.
Step 2: Upload backup to Converter
Now upload the backup on https://converter.elastix.org.
- Email - you will be sent a link to the Elastix 5 configuration once conversion is ready
- Specify your extension length - Extensions length has to be standardized. If you select an Extension length of 4 digits, and have extensions with less digits, then it will make them 4 digits by appending zeros in front. If you have an extension of more than 4 digits then it will be skipped and after the conversion is complete, the email will show a list of errors: “Extension 10000 was not imported due to length longer than dial plan size (5 vs 4). Recreate it manually or run the tool again and modify options.”
- The service will now convert your original TAR file to an Elastix 5 ZIP archive ready to restore and send you an email after a few minutes when it’s done. Converted backups will remain online for 24 hours. Download this file.
Extensions numbers conflicting with system extensions are not imported (Fax, PIN protect, conference menu, and special menu). Others unsupported extensions types are not parsed.
Step 3: Install 3CX and specify restore file
Install 3CX. After the OS is installed, you will be prompted whether you want to setup a new PBX or restore a PBX. Select “Restore” and specify the path to the restore file you downloaded.
The PBX will now be configured and you will be asked some questions as per the Administrator manual.
Once finished with the setup wizard and license is activated, you can then go through each node of the management console and configure them accordingly.
Step 4: Import DIDs
Once your PBX is configured, you can import DIDs & inbound rules. If you have only one trunk you can keep trunk number 10000 and import as is from the Inbound rules node / Import button.
If you have more trunks, you will then need to verify what is the internal trunk number by doing the following:
- Go in SIP Trunks node
- In the Search bar, type 10000 and wait couple of seconds, the list will refresh showing only the one trunk matching this number
- Increment value by 1, and see which trunk matches, and so on
- Open the CSV in Notepad++ and adjust the “PORTS” column value which is set by default to  for all rules to the corresponding virtual number.Save
What is restored
SIP and IAX extensions are restored, with:
- Extension number
- Name (Caller ID field will be split as First Name/Last Name in case it has one space, if none or more then all goes as First Name)
- Email, if voicemail feature was configured
- Outbound caller ID
- SIP ID
A random PIN number is generated for the voicemail of the extension, which will be enabled by default. The operator extension designated will be the first extension parsed. All extensions will be added to an ELASTIX default group, with the User’s role.
SIP trunks are restored, with their:
- Registrar Host
- Registrar Port if specified, otherwise 5060
- Main number
- Default Outbound Caller ID
- Number of maximum calls
A trunk virtual number will be created for each, starting from 10000.
The default route will be the operator extension.
In Elastix 5 inbound rules have to be bound to a specific trunk, while in previous version they were not. Therefore it can’t be restored blindly. We generate a CSV which includes all your DIDs and CIDs, with their route (if extension, IVR, or voicemail).
Trunk number is set to 10000 by default and need to be adjusted manually before import.
DIDs shorter than 4 digits are not imported as this is the minimum length accepted by the system.
The following settings are restored from the outbound routes:
- First dial pattern, given that it has exact match prefix and prepend values only*.
- Up to 5 trunks sequence
- Position of the route
- Emergency route, if so an emergency number is added in PBX settings, but just the route 1 will be considered, and no append value.
*Outbound routes with complex dial pattern expressions with letters or symbols (dash, dot) will be ignored.
IVRs are restored with the below information:
- Timeout destination if Terminate, Extension, other IVR, VM of an extension. Others are replaced by Terminate call.
- Invalid input destination if Extension, or other IVR. Others are replaced by Repeat prompt.
- Menu options for digits 0 to 9, if Terminate, Extension, other IVR, VM of an extension
- Announcement + custom system recording associated
The system recording WAV file is converted automatically to the standardized audio format accepted by the system (WAV, Codec: PCM, Bit rate: 8Khz, Sample: 16bits, Mono).
All blacklisted numbers are restored, with their name and number.
The following feature codes are restored as dial codes:
- Dial voicemail
- Pick parked call
- Intercom prefix
- DND ON
- DND OFF
There are other things that will not be present in Elastix previous versions but should be present in the newer.
Example Tunnel Password, Default fax extension password, and provisioning subfolder name. Those are generated with random credentials.
The admin notification email will be the admin user email address set in Elastix converter tool.