Upgrade TimeXtender from a previous version

This article is a guide for performing a TimeXtender upgrade. If you are interested in learning what has changed in the software, you can review the Release Notes.  

Upgrade Steps:

  1. Download & Install the latest version
  2. Activate the Software
  3. Import Settings from Previous Installation
  4. Upgrade your Repository database
  5. Deploy, Execute, & Validate
  6. Review Performance Recommendations
  7. Reconfigure your Services
  8. Upgrade Subsequent Environments 
  9. Troubleshooting
  10. CData providers

Pre-Upgrade Considerations:

Download & Install the latest version

Download Links & Installation Guide

Activate the Software

Once you launch the software, you will be required to Activate with a License Key. You can find your license key in you current installation of TimeXtender under Help>License Information.


Important: If your application server does not have access to the internet then you will need an offline activation file. To obtain an offline activation file, send your request along with your active license key and the newer version# of TimeXtender to, or you can download an offline activation file by navigating to you product license in the user portal as long as your license supports offline activation AND you have the necessary permissions in the portal. 


Import Settings from Previous Installation

Next, you will have the option to import settings from a previous version,  such as repository database connection properties, accent color, and version detail prompts etc.


Upgrade your Repository database

Once you connect to your existing repository you will be asked asked to upgrade your repository database.  This process will make the necessary adjustments to the database to support the newest version as well as create a backup of repository database in case you need to roll back to previous version of TimeXtender.


TimeXtender will ask you to select the method for upgrading the repository. Web service is typically recommended, however, if your server does not have internet access use Local files


We will reconfigure our services at a later step. 

Deploy, Execute, & Validate

At this point it is recommended to open your project and run a full deploy and execute to ensure everything is working as expected. If you run into some issues after the upgrade please review Common Upgrade Issues to identify a solution. 

Review Performance Recommendations

Newer versions of TimeXtender come with improved features and scripts to increase performance. The Performance Recommendations module can analyze your project and provide recommendations using these new improved features. You can learn more about Performance Recommendations in the User Guide.

To see your the performance recommendations for your project, Right click on the Project Node > Performance Recommendations > Find...


Of course, once confirmed you will need to Deploy & Execute your changes to apply. 

Reconfigure your Services

If you have any running services in this environment now is the time to reconfigure those services. 

Click on the Tools menu > Windows Service Setup.

Stop any previous versions of the service

Once the windows service setup window opens, identify the scheduler service for the previous version.

  1. Right click the previous version of the service > click Stop 
  2. Rick click the service again > click Edit Service
  3. Change the Startup type to Manual
    1. Note the Username of the Service account, you will use this in the next step.


Assign the Service Account to the correct Project Repository

New Installations of TimeXtender point to a default ProjectRepository name. After upgrading you will need to ensure your service accounts are pointing to the correct repository database. The steps below explain how to link the service account with the correct project repository database.

    1. Log into windows using the service account that will be used to run the service and launch TimeXtender. Alternatively, you can navigate to the timextender.exe application file in the installation directory and press Shift+Right-Click and choose Run as different user.
    2. mceclip6.png

    3. Enter the credentials for the Service Account and click OK. This will run the TimeXtender application as the Service Account user.


    4. Once TimeXtender launches for the first time as this Server Account, you will have the option to import settings from a previous version. Select the previous version and TiemeXtender will import the Repository connection settings as well. 


      If you do not see this prompt, go to Tools > Options > Project repository and point to the correct project repository database. 
    5. Close the TimeXtender application.

Start newly installed version of the service

  1. Identify the newly installed version of the scheduler service. 
  2. Right click > Edit Service
  3. Enter the Username and Password of the service account
  4. Set the startup type as Automatic
  5. Check Start/restart service when I click 'OK'
  6. Click OK



After upgrade and modifying the service account, when you attempt to start the new Scheduler service, and it stops again after a while (can be several minutes) then please review and repeat the steps above under the section Assign the Service Account to the correct Project Repository.

Note#2: If you receive the following error, it is likely because the service is connected to a repository that has not yet been upgraded. This is likely the case if you are running multiple environments on the same server. 


You will need to upgrade the other repository database before this service will start.

Upgrade Subsequent Environments 

It is HIGHLY RECOMMENDED that you perform proper testing and validation procedures after upgrading to ensure all systems are operating properly before upgrading subsequent environments. 


If you run into other issues during the upgrade process please review Troubleshooting Upgrade Issues.

CData Providers

Due to the product name change, starting with TimeXtender 20.5.* , new folder paths are created after upgrade.  As a result, existing CData providers are not detected from previous install on the same machine.  Review this article on how to fix it.



Was this article helpful?
0 out of 0 found this helpful


Please sign in to leave a comment.