SOLIDWORKS PDM Archive Copy Tool: Replicate File Vaults for Testing
Overview: The SOLIDWORKS PDM archive copy tool allows administrators to extract specific file archives from a vault, enabling the creation of a lightweight test environment. This is essential for reproducing issues without the overhead of a full vault backup.
Why Use the Archive Copy Tool?
In many engineering organizations, SOLIDWORKS PDM is the backbone of design data management. When problems arise—such as file corruption, unexpected behavior, or integration issues—it’s critical to diagnose them in a safe, isolated environment. Restoring a full database backup to a test server is often impractical due to size and time constraints. Moreover, a database restore alone doesn’t bring over the physical archive files, which are stored separately on the archive server. The archive copy tool bridges this gap by letting you copy only the necessary file archives, along with their referenced dependencies, to a designated output folder. This folder can then be used to populate a test vault, ensuring that both metadata and physical files are consistent.
Prerequisites
- .NET Framework 4.0 or later must be installed on the machine running the tool.
- Access to the SOLIDWORKS PDM database (SQL Server) with appropriate credentials (typically the ‘sa’ account or an account with db_owner privileges).
- Network access to the archive folders (local or UNC paths) where the physical file archives reside.
- Sufficient disk space on the target output location to hold the copied archives.
Step-by-Step Guide to Copying Archives
1. Launch the Tool with Administrative Rights
Right-click the executable and select Run as administrator. This ensures the tool can read registry settings and access network resources if needed.
2. Connect to the SQL Server Instance
Enter the SQL Server instance name (e.g., localhost\PDM), the SQL username (often sa), and the password. Click Connect. Once connected, the vault name and version will appear in the title bar.
3. Select the Vault Database
From the dropdown list, choose the database that corresponds to the vault you want to work with. The list shows all available PDM vault databases on that SQL instance.
4. Configure Archive Folder Paths
Click Select Folders to auto-populate the archive folder paths from the system registry. If you are running the tool on a machine that is not the archive server, you must manually edit each archive folder path (0 through F) to point to the correct location. Use UNC paths for remote shares (e.g., \\server\archive\0). Click Save and Close when done.
5. Set the Output Folder
Choose a local folder where the copied archives will be placed. It’s recommended to use an empty folder or create a new one to avoid mixing with other data.
6. Specify Files to Copy
You can enter Document IDs directly (comma-separated) if known. Alternatively, use the Find Files button to search by file name or folder name. The search dialog supports partial names and wildcards. Check the boxes next to the desired files and click Add DocumentID to populate the list. Use List All with caution on large vaults, as it may take a long time.
7. Add Archives and Set Options
After entering Document IDs, click Add Archives. The tool will locate the corresponding archive folders and automatically include all referenced files (such as drawings of parts or subassemblies) to ensure a complete dataset. You can adjust the copy behavior with these options:
- Copy only latest version: Copies only the most recent version of each file, reducing the amount of data.
- Do not include references: Copies only the selected Document IDs without resolving dependencies. Use this if you only need specific files.
8. Execute the Copy
Click Copy Archives to start the process. A progress indicator will show the status. Once completed, you will find subfolders named 0 through F in your output directory, containing the copied archive files.
Replacing Archives in a Test Vault
After restoring a PDM database backup to a test SQL Server, you will likely encounter errors when accessing files because the archive paths in the database still point to the original production locations. To resolve this:
- Navigate to the local PDM data directory, typically
C:\Program Files\SOLIDWORKS PDM\Data. - Locate the folder corresponding to your test vault.
- Replace the contents of that folder with the archive folders (0-F) you copied earlier.
- Restart the PDM services or IIS if necessary. The test vault should now be fully functional with the selected files.
Important: Always ensure that the database backup and the copied archives are from the same point in time to maintain consistency. Mismatched versions can lead to data corruption or missing references.
Best Practices and Tips
- Run the tool on the archive server itself whenever possible to minimize network latency and permission issues.
- Use a dedicated SQL account with read access to the PDM database to avoid exposing the ‘sa’ password.
- For large assemblies, consider copying only the latest versions to save time and disk space, unless you need to test version-specific behavior.
- Document the Document IDs and the purpose of each test environment to keep track of troubleshooting efforts.
- Regularly clean up test vaults and archive copies to free up resources.
Troubleshooting Common Issues
| Symptom | Possible Cause | Solution |
|---|---|---|
| Tool fails to connect to SQL Server | Incorrect instance name, firewall blocking, or SQL Browser service not running | Verify instance name, ensure TCP/IP is enabled in SQL Configuration Manager, and check firewall rules. |
| Archive folders not found | Registry settings missing or incorrect paths | Manually enter the correct UNC paths; ensure the account has read permissions on the archive shares. |
| Missing references in copied data | “Do not include references” option was selected, or some references are in different vaults | Re-run the tool without that option; ensure all related files are in the same vault. |
| Test vault still shows errors after replacing archives | Database backup and archives are out of sync, or file permissions are incorrect | Restore both from the same timestamp; grant full control to the PDM service account on the new archive folders. |
The SOLIDWORKS PDM archive copy tool is an indispensable utility for administrators who need to troubleshoot issues efficiently. By creating a minimal, focused test environment, you can isolate problems without disrupting the production vault. Mastering this tool will save time and reduce risks when diagnosing complex data management issues.
