Pilot Setup Guide: SuperOffice Database Replication

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.

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
•  Create SQL User: Create a dedicated SQL user for the client.
  • Permission Requirement: The user must have db_owner privileges (or minimally: Read/Write + Create Table rights).
•  Create SQL Schema: The Replication Client is configured to store tables using a specific prefix default: crm7.
  • The provision step will try to create this Schema for you using the db_owner privileges.

  • If your user need - run the following SQL query on your target database to create it manually:
    -- 1. Create the schema CRM7
    CREATE SCHEMA [crm7] AUTHORIZATION [dbo];

    -- 2. Ensure your replication user has access to it
    -- Replace 'YOUR_USER' with the user created in the previous step
    ALTER AUTHORIZATION ON SCHEMA::[crm7] TO [YOUR_USER];
    
    read more about the schema here.

•  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.json and update the ConnectionStrings section. 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.

Performance Impact During Initial Provisioning.

When running the provision command for the very first time, the client triggers the activation of Change Data Capture (CDC) on all tables in your SuperOffice Online Cloud database.

Expected Behavior: This is a heavy, one-time backend operation that temporarily locks tables to update indexes. Active SuperOffice users may experience short-term performance degradation or timeouts (typically lasting 5-10 minutes). It is recommended to run this initial step outside of peak business hours.

Subsequent Runs: Once CDC is enabled, running the provision command again will only verify the existing configuration and will not impact database performance.

1. Open Command Prompt (CMD) or PowerShell as Administrator.
2. Navigate to the installation folder.
3. Run the provisioning command:

SuperOffice.Online.Replication.Client.exe provision

4. Authenticate: A browser window will open. Log in with your SuperOffice Administrator credentials - for your CRM Online tenant.
5. (If multi-tenant) Select Tenant: Choose the customer tenant you wish to replicate.
6. 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.