This article is a guide for performing an ODX and TimeXtender upgrade. If you are interested in learning what has changed in the software, you can review the Release Notes.
- Upgrade ODX Server
- Download & Install the latest version of TimeXtender
- Activate the Software
- Import Settings from Previous Installation
- Upgrade your Repository database
- Deploy, Execute, & Validate
- Review Performance Recommendations
- Reconfigure your Services
- Upgrade Subsequent Environments
- It is not required to uninstall existing versions before upgrading.
- It is recommended to backup your repository database and all SQL databases in your project prior to upgrade.
- If you are moving to a new server or changing the database platform you should ensure all prerequisites are installed.
- If you are using the ODX Server, you must Install & configure the latest version of the ODX Server first.
Considerations for upgrading Multiple Environments
To handle a multiple environment transfer, the two environments involved in the transfer must be using the same version of TimeXtender. Here is the recommended process for upgrading multiple environments.
- Upgrade Dev - Deploy, Execute, & Validate all is working.
- Upgrade Test - Deploy, Execute, & Validate all is working.
- Transfer Dev -> Test - Deploy, Execute, & Validate Test to ensure all is working.
- Upgrade Prod - Deploy, Execute, & Validate all is working.
- Transfer Test -> Prod - Deploy, Execute, & Validate Prod to ensure all is working.
You can wait as long as desired between steps. However, you must do them in the above specified order.
Upgrade ODX Server
On all servers, user accounts and multiple environment setup (if any) :
- Ensure Development has stopped
- Ensure all Deployments have completed
- Ensure any executions are not running on any environment (check Scheduled Executions)
- Stop Scheduler & Server service on all Environments and set to Disabled as you will be installing new versions of these services.
- [Right-Click ODX] shut down ODX Service (from within TimeXtender)
- Download the latest version of ODX Server
- Install the latest version of ODX Server
- Configure ODX Service (follow the prompt on last step of install)
- (If needed) Acquire correct ODX Repository Secret from Portal here: Repositories - TimeXtender Portal
- Ensure you select the same ODX Project as previously used
- You can see ODX Project with most recent activity here: Projects - TimeXtender Portal
- Complete configuration steps
- Start the ODX Service (prompt on last step of install)
For more details, review Configure the ODX Server – TimeXtender Support
Download & Install the latest version of TimeXtender
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 firstname.lastname@example.org, or you can download an offline activation file by navigating to you product license in the Portal as long as your license supports offline activation AND you have the necessary permissions in the Portal.
Download an Offline Activation File for a License
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 differential deploy and execute to ensure the changes to the project if any is updated. Run each area one at a time if the project is very large. 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.
- Right click the previous version of the service > click Stop
- Rick click the service again > click Edit Service
- Change the Startup type to Manual
- 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.
- 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.
- Enter the credentials for the Service Account and click OK. This will run the TimeXtender application as the Service Account user.
- 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 TimeXtender 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.
- Close the TimeXtender application.
Start newly installed version of the service
- Identify the newly installed version of the scheduler service.
- Right click > Edit Service
- Enter the Username and Password of the service account
- Set the startup type as Automatic
- Check Start/restart service when I click 'OK'
- 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.
- Check/Edit all ODX Data Sources and ensure those are pointing to the latest available provider.
- After a successful upgrade, disable previous version of ODX service or uninstall previous version of ODX Server
If you run into other issues during the upgrade process please review Troubleshooting Upgrade Issues.
When upgrading from version prior to 20.5.x new folder paths are created after upgrade. As a result, you will need to edit and refresh CData sources. Review update CData Data Sources and point them to the new provider.
The providers installed from Tools -> Manage CData providers are installed in the folder below. Those are used in a Business Unit data source.
The providers installed from ODX Data Sources -> Manage Data Source providers include both CData and TimeXtender providers. Those are installed in the folder below, and are used in an ODX data source.
I recently upgraded from 20.10.4 version to 20.10.6 version by following this documented steps & I got the similar error like "services started & stopped...." in development server but I'm able to run timextender server service in production. So I'm upgraded to latest version successfully or not??
The upgrade of the ODX repository itself is not subscribed in this article.
You install the new version , configure it and start the ODX Service.
Once you install the new TimeXtender version and have entered the license key you enter the ODX details.
Fill them and when you click 'test connection' you get the error that the ODX needs to be upgraded to the newest version. In this case you have to click 'Next'. You now get an information box that the cloud repository needs to be upgraded and that after that the local backlog will be replaced. This is the upgrade step of the ODX so when you click OK the ODX will be upgraded to the new version (at least this was the case as we upgrade to 20.10.35). Maybe these steps can be added to this article or you can read them here.
Thank you very much for posting detailed steps, when upgrading an older version to a very new version (requiring extra steps).
Please note that Version 21 simplifies instance setup in the cloud, where local backlogs are not used.
It has auto- unloaded previous repository settings. I see what's missing from the blog above. Thanks Syed for putting this together...
This is very helpful ..Will try again tomorrow and see it it works.
Looks like you still need to go through the steps in this article for your Development server. Then, if the issue is not resolved, please open a support ticket.
Are there any options for automating the upgrading of TimeXtender?
e.g. PowerShell script
To resolve a TimeXtender service issue, review this section in the above article Assign the Service Account to the correct Project Repository.
I don't use scheduler but Windows service is required for us to continue using our third party tool Automic-UC4. I've moved from 19.2 to 20.10, stuck at windows service config. Everything else works okay. Getting same error as this link: