Upgrade TimeXtender Data Platform
Upgrades in TimeXtender Data Platform are rolled out on a schedule to keep the service reliable. Administrators are notified by email ahead of an upgrade, and can take it immediately, book it for a day that suits them, or postpone one that is already booked.
Cloud only. This article is aimed at cloud customers. If you are running an on-prem installation, see Upgrading Orchestration and Data Quality.
The Gateway is yours to upgrade. Upgrading the cloud service does not upgrade your gateways. Each one is a Windows service on your own machine and has to be updated there, per server. See the Gateway section of the cloud upgrade article.
Who can do what
| Role | Sees the notice | Can act |
|---|---|---|
| Workspace administrators | Yes | Yes |
| Everyone else | The scheduled notice only | No |
The Upgrade available banner is shown to administrators only, since only they can start an upgrade. The scheduled banner is shown to everyone signed in, because anyone can be affected by downtime, but its Postpone and Upgrade now actions are available to administrators only.
When an upgrade is available
When your workspace is behind the latest release and nothing is booked yet, a banner appears at the bottom of the left navigation sidebar, just above your profile:
Upgrade available · TDP {version} · Learn more
Select the banner to open the Upgrade available window, which names the new version, says what to expect during an upgrade, and links to the release notes. You have three choices:
- Upgrade now: confirm, and the upgrade starts immediately.
- Schedule for a date: pick any day from tomorrow up to 30 days out.
- Remind me later: close the window. The banner stays, so you can decide another time.
Dates in the picker are shown in your workspace's configured timezone, not in yours or the server's. Once you upgrade or schedule, the banner is replaced by the scheduled or in-progress notice automatically.
Selecting Upgrade now twice is safe. Starting an upgrade is idempotent. If one is already running, because the scheduled run reached it at the same moment or because the button was selected twice, it does not start a second time. It reports that the upgrade is already underway. Starting it is instant, and the upgrade itself runs in the background and finishes a little later. The banner shows the final state when it is done.
When an upgrade is scheduled
Whether TimeXtender booked it or you did, a banner reads:
Service upgrade · Scheduled {date}
Select it to open the Upcoming service upgrade window, which shows the date, the maintenance window, and what will happen. Administrators get two actions:
- Postpone: move the upgrade to a later date.
- Upgrade now: bring it forward and run it immediately.
Postpone is capped at 30 days from the originally booked date, not from today. The cap is deliberate: without it, repeated postponement could push an upgrade back indefinitely.
While the upgrade runs, the banner changes to Upgrade in progress.
What happens during an upgrade
- Downtime is about 30 minutes.
- Jobs already running finish first. The upgrade waits for them.
- Queued jobs resume afterwards. Nothing is dropped.
- Your data, models and version history are preserved.
You are given at least 7 days' notice before an upgrade that TimeXtender schedules for you, by email to your administrators and contacts, and by the in-app banner.
After the upgrade
Two things are not upgraded for you and need attention on your own machines:
- Upgrade each TimeXtender Gateway, per server. This is not automatic.
- Upgrade ODQ Desktop, which prompts for its own update.
Best practices
- Book the upgrade rather than waiting to be told. The scheduling window is 30 days, which is enough to land it on a quiet day. An upgrade you chose is easier to staff than one you were given.
- Check your gateways the same day. A gateway does not have to run the same version as the rest of TimeXtender Data Platform. For reliability and full access to new features, we recommend upgrading your gateways as well.
Troubleshooting
I cannot see the banner. Either your workspace is already current, an upgrade is already scheduled, in which case you see the scheduled banner instead, or you are not a workspace administrator.
The confirmation said Upgrade started. but nothing seems to have happened. If the service had already moved past the planned version, the request succeeds without doing anything, because the service is already at the target version or newer.
A gateway stopped working after the upgrade. Its build is older than the service. Upgrade the gateway on that server.
Related articles
- Upgrading Orchestration and Data Quality Cloud, for the gateway and ODQ Desktop procedures
- Packages in TimeXtender Data Platform
