Managing Webgility Desktop Backups and Database Migration for Smooth Operations
This article helps Webgility Desktop users create, restore, and migrate database backups. These processes are crucial for maintaining smooth operations and safeguarding business data during software upgrades or when transitioning to a new computer.
Overview
This guide outlines how to create, restore, and migrate your Webgility Desktop database backups to ensure smooth operation and data integrity when you upgrade your system or change machines.
1. How to Create a Webgility Database Backup
Regularly backing up your Webgility Desktop database is critical for protecting your business data. You can perform backups manually or set up automatic backups using the Scheduler.
-
Manual Backup
- Open Webgility Desktop on your primary computer.
- Navigate to System > Backup.
- Choose a location on your local drive to store your backup file (the default is
C:\Webgility
). - A
.bak
file will be generated. The time required for the backup may vary depending on the size of your database.
-
Automatic Backup (via Scheduler)
- In Webgility Desktop, open Scheduler Settings.
- On the left menu, click Backup your Data.
- Configure the following options:
- Backup Location: We recommend
C:\Webgility\Backups
or a preferred path on a local drive. - Frequency: Select how often you want backups to occur (e.g., Daily, Weekly).
- Overwrite Rules: Define how old backups are handled (e.g., keep the last 5 backups).
- Backup Location: We recommend
- Save your settings and ensure the scheduler is enabled.
2. How to Restore a Webgility Database Backup
Restoring a database backup is essential for recovering from system failures, moving to a new computer, or reverting to a previous configuration.
-
Prerequisites:
- Ensure the
.bak
file you intend to restore is placed in theC:\Webgility
folder on the target machine where Webgility Desktop is installed.
- Ensure the
-
Steps:
- Log in to Webgility Desktop.
- Navigate to System > Backup > Restore.
- Select the correct
.bak
file from the location where you placed it. - After successful restoration, a confirmation message will appear stating: "Backup has been restored successfully."
- Restart Webgility Desktop to complete the process and ensure all changes are applied.
3. Identify the Primary Workstation
Your Webgility Desktop backup files are created and stored on the Primary Workstation, even if a backup process was initiated from an add-on user's machine.
-
How to Locate the Primary Workstation:
- On any computer running Webgility Desktop, go to the folder:
C:\Webgility\UnifyEnterprise\XML
. - Open the file
ApiConfig.xml
using a text editor like Notepad. - Locate the
<SourceName>
tag — the value within this tag indicates the name of your Primary Workstation. - You will use this machine to retrieve your backup files from the
C:\Webgility
folder.
- On any computer running Webgility Desktop, go to the folder:
-
Note: If you are using Webgility Desktop in a hosted environment like RightNetworks, please contact their support for assistance with database backups and migration:
support2@rightnetworks.com
t2vendor@rightnetworks.com
4. How to Move the Webgility Database to a New Computer
This process involves backing up your database from your old computer and restoring it on your new one.
-
Step 1: Create a Backup on the Old Computer
- Follow the Manual Backup steps outlined in Section 1 of this article to create a
.bak
file from your existing database. This is the file you will transfer to your new computer.
- Follow the Manual Backup steps outlined in Section 1 of this article to create a
-
Step 2: Install Webgility Desktop on the New Computer
- Log in to the Webgility portal (portal.webgility.com) and download the latest Webgility Desktop installer.
- Run the setup file and complete the Webgility Desktop installation on your new computer.
- For detailed installation instructions: Refer to the Webgility Installation Guide.
-
Step 3: Install SQL Server Webgility Desktop requires a SQL Server instance to store its database.
-
Option A: Via Webgility Desktop Application (Recommended for new installations)
- When you launch Webgility Desktop for the first time on the new computer, choose the option: “This is a new computer, install SQL server and create Webgility database.”
- Click Continue and follow the on-screen prompts to complete the SQL Server installation.
-
Option B: Manual Installation
- If you need to install SQL Server manually, follow the steps in the SQL Server Installation Guide.
-
-
Step 4: Restore the Database
- Copy the
.bak
file (created in Step 1 from your old computer) to theC:\Webgility
folder on your new computer. - Open Webgility Desktop on the new computer.
- Go to System > Backup > Restore.
- Select your backup file and follow the restoration steps as described in Section 2 of this article.
- Restart Webgility Desktop once the restoration is complete.
- Copy the
-
Post-Migration Validation: After successfully moving your database, perform these checks to ensure everything is working correctly:
- Confirm that your store and accounting connections within Webgility Desktop are active.
- Download a test order to verify that the sync functionality is working as expected.
- If you have add-on users, ensure they can access the shared data.