Follow

PDM File Version Upgrade Utility

Kevin Pham

File Version Upgrade Utility

This guide is written for SolidWorks Enterprise PDM 2014.  This guide can be used if you are using an earlier version because the general process is very similar.

The SolidWorks File Version Upgrade Utility is a tool that allows you to upgrade the files located in your Enterprise PDM vault to the latest version.  The tool automatically checks out, upgrades, saves, and checks native SolidWorks files back into the vault. All references, revision tags, and workflow states remain intact after the process is done. This utility is only used to upgrade native SolidWorks files including .sldprt, .slddrw, and .sldasm. Template and block files must be upgraded manually.

This document covers installing the File Version Upgrade Utility and how to use it.

This is not a troubleshooting guide.  If you have any technical issues with SolidWorks, please contact Hawk Ridge Systems technical support.

This document is only to be distributed and used by Hawk Ridge Systems customers.  Any other use is prohibited.

©2014 Hawk Ridge Systems

 

Installing the File Version Upgrade Utility

Required Upgrade Utility Software

Use a version of the utility software that corresponds to the version of SolidWorks you are upgrading to.

SolidWorks Version

Enterprise PDM Version

Upgrade Utility

SolidWorks 2008

PDMWorks Enterprise 2008

SolidWorks EPDM 2009

From 2008 Install Disk

From 2009 Install Disk

SolidWorks 2009

SolidWorks EPDM 2009

From SolidWorks 2009

SolidWorks 2010

SolidWorks EPDM 2010

From SolidWorks 2010

SolidWorks 2011

SolidWorks EPDM 2011

From SolidWorks 2011

 

System Requirements

There are no specific requirements to use the upgrade utility, as they are varied depending on the vault database that is being upgraded. The database structure, number of files, version, and references being converted all affect the requirements.

It is still recommended to use powerful workstations, as the utility opens up every file in SolidWorks, saves it, and checks it back into the vault. This means that the workstations must be able to handle even the largest assembly structures and components present. Ideally, a 64-bit system with at least 4GB of ram with plenty of hard drive space should run it. You should also stop any other processes before running the utility to free up as much system resources on the workstation as possible.

The following are specific recommendations:

  • Archive server – When the conversion is performed by overwriting existing versions of files, a backup is created for each overwritten file. The archive server must have the disk capacity to store these backup files.

Before the upgrade begins, a window prompt will notify you of the amount of space needed to run the upgrade.

  • Workstations –They must have enough memory to open the largest assemblies fully resolved. 4GB is minimum but 6GB is recommended (on Windows 7 64-bit OS)

Installing the File Version Upgrade Utility

To install the File Version Upgrade Utility:

  1. Navigate to  \Support\File Version Upgrade Utility\ on the installation media for EPDM
  2. Double click File Version Upgrade.exe.
  3. Select Next
  4. Accept the license agreement and click Next.
  5. Click Install.
  6. Click Finish.

 

Upgrading Files with the File Version Utility

Preparing to Upgrade

Before running the upgrade utility, you need to perform a complete vault backup, including the file vault database and archive files. Refer to the Hawk Ridge Systems Backup and Restore Guide on how to do that.

Since the process requires a lot of system resources, you can have several workstations running the utility at once. They will perform concurrent upgrades to reduce the time it takes for the process to finish. The first workstation to run it is set as the master workstation, which creates the upgrade plan.

To prepare the workstations running the upgrade process, the master and slave workstations must first:

  1. Install the same version and revision level of the EPDM client.
  2. Create local views of the file vault to be upgraded.
  3. Check all files into the vault.
  4. Close SolidWorks.

Solely, on the master workstation:

  1. Give participating clients read/write access to all files in the vault you are upgrading.
  2. Create a folder for the work instruction files and share it with full (read/write) permissions for all participating clients.
  3. If it is enabled, disable automatic log off.
  • In the Administration tool, double click License. In the Set License dialog box, click Automatic Log Off. 
  • Clear Log off users automatically after 30 minutes of inactivity.

Before performing the entire conversion of the vault, run on a small batch of files to see if there are any conversion errors.

Select Version Settings

The version settings screen lets you specify which versions and revisions of your selected file type will be upgraded and whether old versions will be overwritten.

Performing a Trial File Upgrade

Before upgrading all the SolidWorks files in the production vault, it’s recommended to perform the upgrade on a copy of the production vault to ensure that there are no issues during the process.

Follow the instructions on how to restore a complete backup of the file vault. Then run the instructions in the next section, Running the Upgrade Utilty, to perform the trial file upgrade.

Running the Upgrade Utility

  1. Start the File Version Upgrade Utility by doing one of the following:
  • On Windows 7 and Windows Server systems older than Windows Server 2012, select All Programs à SolidWorks Enterprise PDM à File Version Upgrade.
  • On Windows 8 and Windows Server 2012 or later, on the Apps screen, under SolidWorks Enterprise PDM, select File Version Upgrade.
  1. On the Welcome screen, do one of the following:
  • To set up the upgrade, click Initiate a new upgrade process (Master Workstation).
  • To run a work instruction file created for the upgrade, click Participate in an upgrade process (Slave Workstation).
  1. Follow the instructions in the upgrade wizard.

Creating and Using Work Instruction Files

By creating work instruction files, you can have multiple workstations running the upgrade utility at a single time. The file will be created on the first, or master, workstation.

To create and use work instruction files:

  1. Create a shared folder and give each workstation participating in the upgrade Read/Write access to it.
  2. Start the File Version Upgrade Utility by doing one of the following:
    1. On Windows 7 and Windows Server systems older than Windows Server 2012, select All Programs à SolidWorks Enterprise PDM à File Version Upgrade.
    2. On Windows 8 and Windows Server 2012 or later, on the Apps screen, under SolidWorks Enterprise PDM, select File Version Upgrade.
  3. On the Welcome screen, select Initiate a new upgrade process (Master Workstation).
  4. Follow the instructions in the upgrade wizard.
  5. On the Upgrade Settings screen:
    1. Under Upgrade Settings, select Divide the upgrade work into multiple work instruction files.
    2. Specify the number of work instruction files to create.
    3. For Shared location for work instruction files, type the name of the shared folder you created in step 1 or click the browse button to navigate to the folder. The folder name must be in UNC format.
    4. Click Next.
  6. On the Ready to Upgrade Files screen, do one of the following:
    1. To upgrade now, click Yes.

When a completion message appears, click OK.

  1. To exit the upgrade utility and run work instruction files at a later time, click No.
  2. If you select No in step 6, run the File Version Upgrade tool again to perform the upgrade using the work instruction files.
  3. On the Welcome screen, select Participate in an upgrade process (Slave Workstation).
  4. On the Select Work Instruction File screen:
    1. Browse to the location of the work instruction files.
    2. Select the work instruction file to process.
    3. Click Next.
    4. The Work Instruction File Summary displays with a read-only summary of the settings specified for the upgrade.
    5. Click Next.
  5. On the Ready to Upgrade Files screen:
    1. Click View Files to see a list of files that will be upgraded.
    2. To upgrade the files, click Yes.
    3. When a completion message appears, click OK.

Completing an Interrupted Upgrade

In some cases, the utility may fail unexpectedly and not finish the file upgrade process. In order to complete an upgrade that has been interrupted:

  1. Click Retry in the error message.
  2. In the message indicating that the conversion did not complete successfully, click OK.
  3. Click Exit.
  4. Solve the problem that caused the interruption. For example, restore the network or restart the computer.
  5. Run the Upgrade utility again.
  6. On the Welcome screen, select Restart an interrupted upgrade process (Master and Slave Workstation).
  7. On the Continue Interrupted Migration screen, click Next.
  8. On the Work Instruction File Summary screen, click Next.
  9. On the Ready to Upgrade Files screen, click Finish.

After Upgrading

When the upgrade is complete:

  • View the upgrade log files and find the files that were unable to upgrade automatically and manually upgrade them.
  • Optionally, use Get Latest Version to create local copies of files that were converted on other workstations.
  • Open various files to check and see if the upgrade was successful.
  • If you selected to overwrite existing versions of files, after checking that the upgrade is successful, delete the backup files from the archive server.

File Name Formats for Upgrade Logs

File names in upgrade logs have the following formats:

  • Files that were upgraded – “Upgrade <id>Batch<n>.log” where <id> is a unique alphanumeric string and <n> is the number of the batch file for which the log was created
  • Files that could not be upgraded – “Upgrade <id>Batch<n> Errors.log”

Managing Backup Files

If you chose to overwrite existing versions of files when you upgrade, the upgrade tool creates a backup file for each overwritten file. These backup files remain after the upgrade is complete. You can choose whether to delete them or keep them after the process is done.

Backup File Creation

It is not possible to disable the backup option, so check to see that there is enough disk space on the archive server before using the upgrade utility.

The Ready to Upgrade Files screen gives an estimate of the amount of space required.

For each overwritten file:

  1. The tool retrieves the original version of the file from the file archive folder to the client system that is running a work instruction file.
  2. The file is opened in SolidWorks, upgraded and sent back to the archive folder when the batch process completes.
  3. Before the version is replaced, the original version in the archive is renamed in the following format:
  • Bak_counter_version.extension where:
    • o bak is the prefix for all backup files.
    • o counter is a unique counter in case the existing file with the same backup name exists from a previous upgrade.
    • o version is the number, in hexadecimal format, of the file version that is being replaced.
    • o extension is the file extension.
  1. The upgrade tool places the upgraded version of the file in the archive using the original filename.

Restoring an Incorrectly Upgraded Version from a Backup

If an upgraded version of a file is incorrect, the backup can be used to restore the original version of the file.

  1. In the local file vault view, determine the name of the file to find.
  2. Open Microsoft SQL Server Management Studio and click Connect.
  3. Expand Databases and select the vault containing the file you want to restore.
  4. Click New Query.
  5. In the right pane, type a query in the following format:

 

select * from documents

where filename like ‘<filename>’

 

(replace <filename> with the name of the file located in step 1)

  1. Click Execute.

Record the files DocumentID, which is listed in the Results tab.

  1. Exit the SQL Server Management Studio.
  2. Use a calculator to convert the DocumentID to hexadecimal format.
  3. In an Explorer window, navigate to the archive server data folder (typically C:\Program Files\SolidWorks Enterprise PDM\Data\vault_name)
    1. If the archive server data folder is not listed above, to locate it:

                                  i.    Run regedit.

                                 ii.    Navigate to HKEY_LOCAL_MACHINE\SOFTWARE\SolidWorks\Applications\PDMWorks Enterprise\ArchiveServer\Vaults\vault_name\ArchiveTable

The file archives are spread out over 16 subfolders. If the vault archive has been split up, some of those subfolders may be on different drives.

  1. Expand the vault archive that matches the last digit of the hexadecimal number.
  2. Expand the folder that matches the hexadecimal number.
  3. Rename or delete the version of the file you want to restore.
  4. Rename the appropriate bak_ file to the original file name.

Locating and Removing Backup Files

When the upgrade is complete and all of the files are converted to the latest version, the backup files can be removed in order to free up disk space on the archive server. Each file archive is stored under the file vault archive folder.

  1. To locate the file vault archive folder:
    1. Run regedit.
    2. Navigate to HKEY_LOCAL_MACHINE\SOFTWARE\SolidWorks\Applications\PDMWorks Enterprise\ArchiveServer\Vaults\vault_name\ArchiveTable

The file archives are spread out over 16 subfolders. If the vault archive has been split up, some of those subfolders may be on different drives.

  1. Use Windows search or another search method to search for all files under the vault archive with a name starting with bak_.
  2. Delete all the files that are found.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments