Pilot Setup Guide: SuperOffice Database Replication
Version: 1.0 (Pilot Phase)
Status: Beta / Parallel Run
This document outlines the technical requirements and steps to set up the new SuperOffice Replication Pilot. Unlike the legacy "Mirroring" solution, this client uses Change Data Capture (CDC) to stream data changes from the SuperOffice Cloud (Source) to your local SQL Server (Target) in near real-time.
Pilot Strategy for customers using "Database Mirror":
During the pilot phase, you must run this replication client in parallel with your existing mirroring solution. Do not disable legacy mirroring until data integrity has been validated.
Change Data Capture: Enabling CDC increases the database size (approx. +20%) and transaction log usage
Summary of tasks:
1. Target DB: Create a new, empty local SQL database. Create a user with db_owner privileges2. Download: Get Replication Client zip
3. Edit: Open appsettings.json. Update ConnectionStrings to point to your local target
4. Execution (Run as Admin) Run the following commands in order via CMD/PowerShell:
a) Link Tenant b) Initial Load c) Register Service d) Start Service
SuperOffice.Online.Replication.Client.exe provision
SuperOffice.Online.Replication.Client.exe sync
SuperOffice.Online.Replication.Client.exe install
sc start "SuperOffice Replication Client"
- Request Backend Enablement: Submit the Pilot Entry Form to request backend preparation.
- Note: SuperOffice Operations must manually enable Primary Keys on the source database before you proceed.
- Open and submit this form
- Network Configuration: Whitelist the following hostnames for outbound traffic (HTTPS/443):
id.superoffice.com(Authentication)online.superoffice.com(Replication Stream)
- Create Target Database: Create a new, empty SQL database on your local server (or Azure SQL).
- Example Name:
SuperOffice_Replication
- Example Name:
- Create SQL User: Create a dedicated SQL user for the client.
- Permission Requirement: The user must have
db_ownerprivileges (or minimally: Read/Write + Create Table rights).
- Permission Requirement: The user must have
- Download Client: Download the Replication Client (zip file). (Later: Log in to OC and download)
- Extract Files: Unzip to a dedicated folder (e.g.,
C:\Replication\). - Configure Connection: Open
appsettings.jsonand update theConnectionStringssection. Example on how a connection string look like:
"ConnectionStrings": {
"DefaultConnection": "Server=YOUR_SERVER;Database=YOUR_DB;User Id=YOUR_USER;Password=YOUR_PASSWORD;TrustServerCertificate=True;"
}Prerequisite: Ensure you have received confirmation from the Pilot Team that Backend Enablement is complete.
- Open Command Prompt (CMD) or PowerShell as Administrator.
- Navigate to the installation folder.
- Run the provisioning command:
SuperOffice.Online.Replication.Client.exe provision
- Authenticate: A browser window will open. Log in with your SuperOffice Administrator credentials - for your CRM Online tenant.
- (If multi-tenant) Select Tenant: Choose the customer tenant you wish to replicate.
- Create Session: Enter a unique name for this replication session (e.g., Pilot_Prod_Node_01).
- [ ] Run Initial Sync: Download the schema and initial data load.
SuperOffice.Online.Replication.Client.exe sync
Duration depends on database size. This step creates the tables in your local SQL DB.
- [ ] Install as Service: Register the client as a Windows Service for continuous background operation.
- [ ]Start Service: Start the Windows Service for continuous background operation.
SuperOffice.Online.Replication.Client.exe install
sc start "SuperOffice Replication Client"
- [ ] Verify Service is started.
- [ ] "Database Mirror"-customers - Data Validation: Periodically compare row counts between your legacy Mirroring database and the new Replication database to ensure integrity.
- [ ] Monitor Disk Space: Ensure your local server has sufficient storage for the growing database.