Upgrading
Published 12 March 2015
This page describes:
Upgrading to DLM Automation Suite 1.3 or later
This section describes how to upgrade to DLM Automation Suite 1.3 or later from:
- DLM Automation Suite 1.2 or earlier
- the SQL Automation Pack
We've simplified the DLM Automation Suite installation process in 1.3 and later. SQL CI and SQL Release are now installed as part of the suite, so you no longer need to run separate installation processes for those tools. For information about installing the suite, see Installing.
Breaking changes
The upgrade to DLM Automation Suite 1.3 or later will cause a breaking change if any of the following are true:
- DLM Automation Suite 1.2 or earlier wasn't installed in the default location.
The upgrade will remove the existing version and install the latest version in the default location C:\Program Files (x86)\Red Gate. You'll need to update references to the tools in the suite. See Updating references to DLM Automation Suite tools. - you're using references to SQL Compare and SQL Data Generator.
We've changed their location within the suite, so existing references won't work. See Updating references to DLM Automation Suite tools. - you've previously installed SQL CI separately, using the SQLCISetup.exe installer.
The upgrade will remove the existing version and install the latest version in the default location C:\Program Files (x86)\Red Gate\DLM Automation Suite 1. - you're using the TFS Build plugin.
You'll need to update to the latest version of the plugin and recreate your build configuration. See Updating the TFS Build plugin. - you're using the TFS MSBuild scripts.
You'll need to update the sqlci.global properties file. See Updating the TFS MSBuild scripts
Updating references to DLM Automation Suite tools
The new DLM Automation Suite installer creates a %DLMAS_HOME% variable. We recommend that you update existing references to tool executables with %DLMAS_HOME%
You must update references to SQL Compare and SQL Data Generator. Existing references won't work, because their default installation locations have changed to:
- SQL Compare - C:\Program Files (x86)\Red Gate\DLM Automation Suite 1\SC
- SQL Data Generator - C:\Program Files (x86)\Red Gate\DLM Automation Suite 1\SDG
The locations for tool executables are:
| Tool executables | Location |
|---|---|
| SQL CI | %DLMAS_HOME%\SQLCI\sqlCI.exe |
| SQL Compare | %DLMAS_HOME%\SC\SQLCompare.exe |
| SQL Data Compare | %DLMAS_HOME%\SDC\SQLDataCompare.exe |
| SQL Data Generator | %DLMAS_HOME%\SDG\SQLDataGenerator.exe |
| SQL Doc | %DLMAS_HOME%\SDOC\SQLDoc.exe |
Once the installer creates the environment variable, you'll need to restart every application that references them.
Updating the TFS Build plugin
Once you've upgraded to DLM Automation Suite 1.3 or later, you'll need to update both the TFS Build plugin and the .sqlciproj SQL CI project file.
When you update the .sqlciproj SQL CI project file, any changes you've made to this file outside the TFS Build plugin will be lost.
If the file does contain changes, save a copy of it somewhere outside the Visual Studio project subfolder before you follow the instructions below. Once you've worked through the instructions, refer to the copied file to recreate your changes.
- Install the latest TFS Build plugin. See Setting up the TFS Build plugin
Open the .sqlciproj SQL CI project file. This will be in a subfolder of the Visual Studio project.
At the dialog box asking to update the file, click Yes.
Save the file.
On the machine running your build agent, restart the TFS build service. Open Windows Services (services.msc).
In the list of services, right-click on Visual Studio Team Foundation Build Service Host [year] and select Restart.
This allows the agent to start using SQL CI's %DLMAS_HOME% environment variable.
Updating the TFS MSBuild scripts
Once you've upgraded to DLM Automation Suite 1.3 or later, you'll need to update the TFS MSBuild scripts:
- Replace your existing .proj and .targets files under version control with the new files in the DLM Automation Suite.
- Open the SQLCI-steps\SQLCI.global.properties file and delete the
sqlCIFolderproperty. - On the machine running your build agent, restart the TFS build service. Open Windows Services (services.msc).
- In the list of services, right-click on Visual Studio Team Foundation Build Service Host [year] and select Restart.
This allows the agent to start using SQL CI's %DLMAS_HOME% environment variable.
Upgrading from the SQL Automation Pack
If you have an existing SQL Automation Pack license, a serial number for the DLM Automation Suite has been generated for you. To find it:
- Go to https://www.red-gate.com/Dynamic/account/Serials and log in to your Redgate account.
- On the Serial numbers tab, copy your DLM Automation Suite serial number.
Once you've installed the DLM Automation Suite, you can activate your new serial number using any of the tools it contains. For more information, see Activating.
Notification of future updates
There won't be any future updates to the SQL Automation Pack. The tools it contained are now part of the DLM Automation Suite.
We've also changed the way we alert you to new releases. Previously, the Intro to SQL Automation Pack > About page included a Check for updates button. The new DLM Automation Suite app doesn't support this. Instead, we'll tell you about updates to the DLM Automation Suite with monthly emails.
If you've previously unsubscribed from Redgate's email lists but want to receive monthly updates, log in to your Redgate account and update your email preferences.
What if I don't upgrade right away?
Your SQL Automation Pack serial number is still valid so you can keep using it, but we recommend upgrading as soon as possible. Once you upgrade, you can:
- install SQL Release and use the Octopus Deploy step templates.
- install future versions of the tools that were part of the SQL Automation Pack.
- install future versions of the DLM Dashboard once it's out of beta.
Where are the Oracle tools?
The Oracle tools that were part of the SQL Automation Pack are now part of the DLM Automation Suite for Oracle. For more information, see DLM Automation Suite for Oracle.
Upgrading from SQL Automation Pack v1.0.x.x
The SQL CI versions that were part of SQL Automation Pack v1.1.x.x releases contained a rewritten version of SQL CI which was not compatible with 1.0.x.x versions.
If you're upgrading to the DLM Automation Suite from one of the SQL Automation Pack 1.0.x.x versions, you must reconfigure your existing SQL CI build steps after installation.
For more information, see Upgrading from SQL Automation Pack 1.0.x.x to 1.1.x.x and later.
