Getting Started - Upgrading
Upgrading the version of DriveWorks used in a production environment requires planning to avoid unnecessary downtime to users of the live implementation.
This topic provides the following information to assist in all aspects of upgrading DriveWorks and associated applications:
About Minor Version Upgrades
The information in this topic refers to "minor version upgrade".
A minor version (or service pack) upgrade involves upgrading the service pack (SP) of an existing major version.
For example, moving from:
DriveWorks 23 SP0 to DriveWorks 23 SP1
Minor Version Matching
Minor versions of all DriveWorks Pro modules must match.
When more than one module of DriveWorks Pro is in use, the service pack of each module must be identical.
Minor versions cannot be installed alongside older minor versions (service packs) of the same major version.
We recommend the previous minor version is uninstalled before installing the new minor version.
About Major Version Upgrades
The information in this topic refers to "major version upgrade".
A major version upgrade involves upgrading an earlier major version to a newer major version.
For example, moving from:
DriveWorks 22 SP2 to DriveWorks 23 SP1
DriveWorks 23
DriveWorks 23 introduced a significant change to DriveWorks Pro Server and the connection to shared groups.
Where applicable the information below distinguishes between upgrading a major version to 23 or versions prior to this.
Upgrading SOLIDWORKS
When the version of SOLIDWORKS that DriveWorks uses is to be upgraded it is important to ensure the DriveWorks add-in is registered in SOLIDWORKS.
This applies to SOLIDWORKS installations that interact with DriveWorks to:
- Capture CAD data to be automated
- Run specifications in the SOLIDWORKS task pane
- Generate CAD data automatically.
Learn moreMoving From DriveWorksXpress or DriveWorks Solo
Upgrading DriveWorksXpress Projects
Automation projects set up with DriveWorksXpress can be used and enhanced in DriveWorks Pro.
Learn moreUpgrading DriveWorks Solo Projects
Automation projects set up with DriveWorks Solo can be used and enhanced in DriveWorks Pro.
Learn moreBefore Upgrading the Production Environment
Prior to upgrading the installed DriveWorks version on the production environment it is important to test the new version with the working data.
This should be done in an environment that is isolated from the production environment, more commonly known as a sandbox environment.
Each DriveWorks module being tested will need a license and the data to be tested will require to be copied from the production environment.
Licensing
As the upgrade is to be tested in the sandbox environment each module to be tested will require a license.
For a major version upgrade (license entitlement not previously activated) the license entitlement can be activated in the sandbox environment and then returned for activating in the production environment when testing is complete.
Each new major version of the License Manager will:
- Manage Fixed Licenses from all previous major versions that have been activated on that machine.
- Manage and serve Network Licenses from all previous major versions that have been activated on that machine.
- Manage and serve DriveWorks Live Licenses from all previous major versions that have been activated on that machine.
Older major versions of the License Manager cannot manage or serve licenses for newer major versions.
For a minor version upgrade (license entitlement activated and in use in production) the following options are possible:
Returning Licenses
If the original License Entitlement document is not to hand, each license code can be copied from the License Details dialog by clicking the View License button in the License Manager.
Adding and Activating Licenses
Copy the Group and Data to be Tested
Production data should not be tested on new versions of DriveWorks.
Copying the production data to the testing environment is essential.
DriveWorks Data Management provides the following tasks to accomplish this:
Copy Group - recommended
This method requires a network connection between the data being backed up and the target (sandbox environment) location.
DriveWorks Pro Server should be installed and running (in the environment the group and data is being copied to) before using Copy Group.
Pack and Go
With this method the group and data to be tested can be backed up at any point prior to the data requiring to be restored.
Pack and Go will convert a shared group to an individual group.
This should not result in any data loss, however please note the following:
- Large datasets will take a long time for the Pack and Go to run.
- Large datasets will result in a large .drivepkg file.
- We recommend a SQL backup is taken independent of the converted shared group contained in the .drivepkg file, see How To: Backup a SQL Server Database for more information.
The Pack and Go file will need to be restored on the machine requiring the data.
See Restoring a Pack and Go Package File for more information.
Test on a Sandbox Environment
We recommend using a sandbox environment, isolated from the DriveWorks data used in production, to test and prove the existing implementation with the new DriveWorks version.
The sandbox environment should match the production environment in terms of:
- Hardware
- Operating system
- Database (used for Shared Groups and any other data connections)
- Other third party applications (Microsoft Office, CAD and PDM), if applicable
- Have a network connection to the machine hosting the production group and data to enable transfer of the data to be tested.
- Have a usage close to that seen in production (number of users and specifications).
The steps to follow to enable testing the new DriveWorks version with the production data is as follows:
- Install and License all required modules of the DriveWorks version to be tested.
See Licensing for more information.
- Start DriveWorks Pro Server to enable the production group to be copied to it.
- Copy the group and data to be tested.
On the sandbox machine, launch DriveWorks Data Management and:
- Open the source group, this is the shared group on the production environment that will be copied to the sandbox environment.
- Follow the steps in How To Use Copy Group to copy the group to the target group (sandbox environment).
If a connection to the source group (production) is not possible from the sandbox environment the production data will require to be backed up using Pack and Go.
See How To: Backup an Individual or Shared Group and Data - DriveWorks Data Management - Pack and Go for more information.
- Ensure the group is owned and hosted by DriveWorks Pro Server:
- Testing DriveWorks Live.
For a DriveWorks Live test, complete the following:
- Launch DriveWorks Live and use the Open Group wizard to connect to the sandbox Pro Server shared group.
- Select Stage 1: Specification > Live and click the Theme button.
- Select the Theme being used in the production environment.
- Follow the steps to update the relevant files in the topics below:
- Open the group (using the Open Group wizard) on each DriveWorks module.
- Run tests
Upgrading the Production Environment
Plan a suitable downtime period for the upgrade to take place.
Close all DriveWorks modules and tools that may be open on the production environment.
Each section below is listed in the preferred order of upgrade.
Ignore sections that cover modules that are not in use.
1. DriveWorks License Server Upgrade
This is required on the machine that serves any network licenses (DriveWorks Administrator or DriveWorks User) or DriveWorks Live licenses (Centralized License, DriveWorks Live Insights License or OnDemand License) to the modules in use on the production environment.
Machines that use fixed licenses (DriveWorks Administrator, DriveWorks User or DriveWorks Autopilot) can have the License Manager updated at the point the module is installed.
See Licensing above for more information.
- Return licenses
If license entitlement was used for testing on the sandbox environment, they must be returned from that machine.
- Uninstall previous DriveWorks License Management version
- Install new DriveWorks License Management version
- Activate licenses
2. DriveWorks Pro Server Upgrade
Follow these initial steps, and then continue with the steps for Minor Version Upgrade or Major Version Upgrade.
- Uninstall previous Pro Server version
- Install new Pro Server version
- Launch DriveWorks Pro Server.
2a. Minor Version Upgrade
Continue with the steps below when upgrading to a new minor version only.
Upgrading the minor version of DriveWorks 22 and earlier:
- Launch DriveWorks Pro Server Configuration Tool
- Ensure SQL Connection Details are correct
- Ensure Pro Server Service is running.
- Ensure the Group is owned and hosted by the service.
Upgrading the minor version of DriveWorks 23 and onwards:
- Launch DriveWorks Pro Server Management Console
- Ensure the Pro Server database is connected.
- Ensure the Group is connected (green indicator).
2b. Major Version Upgrade
Continue with the steps below when upgrading to a new major version only.
Upgrading the major version to DriveWorks 22 and earlier:
- Launch DriveWorks Pro Server Configuration Tool
- Connect to the SQL Server that hosts the production group, see SQL Connection Details.
- Start the Pro Server Service.
- Force Ownership and Upgrade the Group.
Upgrading the major version from DriveWorks 22 and earlier to DriveWorks 23 and onwards:
- See Upgrading From A Previous Major Version for the steps to follow.
3. DriveWorks Live Upgrade
Follow these initial steps, and then continue with the steps for Minor Version Upgrade or Major Version Upgrade.
- Backup customization files
- Uninstall previous DriveWorks Live version.
- Install new DriveWorks Live version.
- Launch DriveWorks Live and connect to the License server to obtain a license.
3a. Minor Version Upgrade
Continue with the steps below when upgrading to a new minor version only:
- Open the production group:
- Groups and Projects can be opened as usual including quick links from the Recent list (in the DriveWorks Today task).
- All customizations and settings applied in the previous installed version will be retained when the new version is launched.
- DriveWorks Live may require the DriveWorks Live Service to be started.
See To Start a Live session for more information.
- If DriveWorks Live is run through IIS (Internet Information Services) the Application Pool may need to be restarted.
See IIS Management - Application Pools
3b. Major Version Upgrade
Continue with the steps below when upgrading to a new major version only.
- Open the production group using the Open Group Wizard to open the upgraded shared group:
- This ensures the correct shared group is opened.
All methods to quickly open a shared group (Open Group drop down, recent list, automatically open last group, etc.) will try and connect to the previous reference.
We recommend all previous references to the old shared group (and projects) are cleared from the recent list.
- All settings applied in the previous installed version will be retained when the new version is launched.
- Reapply customizations to the Theme files:
For the Integration Theme see Reapply Customizations.
For the Web Theme see Major Version Upgrade.
- DriveWorks Live may require the DriveWorks Live Service to be started.
See To Start a Live session for more information.
- If DriveWorks Live is run through IIS (Internet Information Services) the Application Pool may need to be restarted.
See IIS Management - Application Pools
5. DriveWorks Autopilot Upgrade
Follow the steps below to upgrade DriveWorks Autopilot on each machine it is currently installed.
- Return Fixed License
See Returning Licenses above for information.
- Uninstall Previous Version
This step is optional for a major version upgrade.
- Install New Version
- Launch DriveWorks Autopilot and license
To activate a Fixed License see Activating Licenses.
- Open the production group using the Open Group Wizard to open the upgraded shared group:
Upgrading the minor (all versions) or major version (DriveWorks 22 and earlier):
- Groups and Projects can be opened as usual including quick links from the Recent list (in the DriveWorks Today task).
- All settings applied in the previous installed version will be retained when the new version is launched.
Upgrading the major version to DriveWorks 23 and onwards:
- From DriveWorks 23 shared groups require the protocol, machine name and port number of the Pro Server machine to establish a connection.
All methods to quickly open a shared group (Open Group drop down, recent list, automatically open last group, etc.) will try and connect to the previous reference.
We recommend all previous references to the old shared group (and projects) are cleared from the recent list.
- All settings applied in the previous installed version will be retained when the new version is launched.
- If DriveWorks Autopilot was previously started from a command line script, please see How To: Automatically Start Autopilot Adding Timeout for DriveWorks Pro Server 23 Onwards.
6. DriveWorks Administrator and User Upgrade
Follow the steps below to upgrade DriveWorks Administrator and DriveWorks User on each machine it is currently installed.
- Return License
See Returning Licenses above for information.
When using a Network License closing DriveWorks User and SOLIDWORKS (if applicable) will be sufficient.
- Uninstall Previous Version
This step is optional for a major version upgrade.
- Install New Version
- Launch DriveWorks Administrator and DriveWorks User and license
To obtain a network license or activate a fixed license see Activating Licenses above for information.
- Open the production group using the Open Group Wizard to open the upgraded shared group:
Upgrading the minor (all versions) or major version (DriveWorks 22 and earlier):
- Groups and Projects can be opened as usual including quick links from the Recent list (in the DriveWorks Today task).
- All settings applied in the previous installed version will be retained when the new version is launched.
Upgrading the major version to DriveWorks 23 and onwards:
- From DriveWorks 23 shared groups require the protocol, machine name and port number of the Pro Server machine to establish a connection.
All methods to quickly open a shared group (Open Group drop down, recent list, automatically open last group, etc.) will try and connect to the previous reference.
We recommend all previous references to the old shared group (and projects) are cleared from the recent list.
- All settings applied in the previous installed version will be retained when the new version is launched.
Upgrading SOLIDWORKS
When upgrading the version of SOLIDWORKS that DriveWorks uses to capture, specify or generate CAD data follow the steps below to ensure the DriveWorks add-in is registered.
Installing a new version of SOLIDWORKS
Applies when any of the DriveWorks modules below are installed on the machine where SOLIDWORKS is being upgraded.
- DriveWorks Administrator
- DriveWorks User
- DriveWorks Autopilot
- DriveWorks Live
When upgrading the version of SOLIDWORKS in use, we recommend following the steps below:
This ensures the DriveWorks Add-in for SOLIDWORKS will be reinstated once SOLIDWORKS has been upgraded.
- Ensure the version of DriveWorks in use is compatible with the version of SOLIDWORKS being upgraded.
See Supported DriveWorks Versions for a list of DriveWorks versions and the tested version of SOLIDWORKS each support.
- Back up all captured master models and drawings.
We recommend using SOLIDWORKS Pack and Go.
- Return any DriveWorks licenses in use on the machine SOLIDWORKS is being upgraded on.
See View a Fixed License for more information.
If the machine SOLIDWORKS is being upgraded on is also the Network License Server (for DriveWorks network licenses) see To Return a Network License for more information.
- Uninstall DriveWorks.
- Upgrade SOLIDWORKS.
- Re-install DriveWorks and re-activate any returned DriveWorks licenses.
- Save all captured models and drawings in the new SOLIDWORKS version.
SOLIDWORKS major versions must match on each machine that uses DriveWorks.