Getting Started

デモでは、Customer Portal、CRM、Field Serviceと3種類の業務DBをまとめて起動します。実際の同期処理と同じ経路を使うため、製品の動きを一通り確認できます。

リポジトリのルートで、次のコマンドを実行します。

dotnet tool restore
dotnet restore SyncCoordinator.sln
dotnet build SyncCoordinator.sln --no-restore
dotnet test SyncCoordinator.sln --no-build
aspire run --apphost src/SyncCoordinator.AppHost/SyncCoordinator.AppHost.csproj

デモでは、業務システムとDB接続、無効な同期ルール、テーブル／列マッピングまで用意されています。同期用テーブルとTriggerはまだ業務DBへ反映されていません。

初回起動時は、Webサーバー自身のブラウザーから管理者パスワードを登録します。初期設定画面は外部PCから開けません。

1. 1
   初期設定画面を開く

   Webサーバー上でhttp://localhost:<Webのポート>/account/setupを開きます。

2. 2
   パスワードを登録する

   12文字以上128文字以下のパスワードを設定します。ユーザー名はadmin固定です。

3. 3
   ログインする

   設定したパスワードでログインすると、ダッシュボードが表示されます。

初期設定とパスワード再設定は、接続元とアクセス先の両方がlocalhostまたはループバックIPの場合だけ利用できます。

デモの設定は管理DBへ初期投入されています。まず内容を確認してください。設定を変更するときも、実環境で新しく作るときも同じ管理画面を使います。

デモでもこの操作は必要です。各ルールの「DBへ反映」でSQLを確認し、同期用オブジェクトを両側の業務DBへ反映します。

1. 1
   変更内容とSQLを確認する

   送信元・送信先それぞれの作成対象と実行SQLを開きます。

2. 2
   業務DBへ反映する

   デモでは管理画面から反映できます。本番ではDBAがSQLを確認して実行する方法を推奨します。

3. 3
   すべてのDBを確認する

   補助テーブルとTriggerの存在、定義が一致していることを管理画面から検証します。

4. 4
   ルールを有効にする

   両側のDBが検証済みになったら、基本設定から同期対象にします。

追加するのは変更検知と重複防止に必要な補助テーブルとTriggerです。既存の業務アプリケーション、業務テーブル、業務列は変更しません。

ルールを有効にしたら、Customer Portalなど送信元のサンプルデータを1件変更します。初期データはTrigger反映前に作られているため、更新して最初の同期を開始します。

デモ用DBを本番へ移すのではなく、CoreモードでWebとWorkerを起動し、実際の業務システムを管理画面から登録します。管理画面の操作とDB反映の流れは、デモで行った手順と同じです。

1. Coordinator管理DBを用意する

管理DBはSyncCoordinatorの設定、処理状態、競合履歴を保存するSQL Serverです。業務データを保存するDBとは別です。

2. AppHostをCoreモードにする

src/SyncCoordinator.AppHost/appsettings.Development.jsonへ次の設定を反映します。以下は外部SQL Serverを使う例です。

{
  "RunMode": "Core",
  "CoordinatorDatabase": {
    "UseContainer": false
  }
}

3. 管理DBの接続文字列を登録する

外部SQL Serverを使う場合は、ConnectionStrings:coordinator-dbをAppHostのUser Secretsへ登録します。パスワードを設定ファイルへ書かないでください。

dotnet user-secrets set --project src/SyncCoordinator.AppHost "ConnectionStrings:coordinator-db" "Server=localhost,1433;Database=SyncCoordinator;User ID=your-user;Password=your-password;Encrypt=True;TrustServerCertificate=True;MultipleActiveResultSets=true"

管理DBをコンテナで起動する場合、この接続文字列の登録は不要です。

4. 起動して実際の業務DBを登録する

aspire run --apphost src/SyncCoordinator.AppHost/SyncCoordinator.AppHost.csproj

Coreモードにはデモの初期設定がありません。初回ログイン後、「システム」で業務DBを登録し、デモで確認した手順と同じようにルール、マッピング、DB反映を進めます。

$env:SYNC_COORDINATOR_DESIGN_CONNECTION = "Server=localhost,1433;Database=SyncCoordinator;User ID=your-user;Password=your-password;Encrypt=True;TrustServerCertificate=True;MultipleActiveResultSets=true"
dotnet tool restore
dotnet tool run dotnet-ef database update --project src/SyncCoordinator.Infrastructure/SyncCoordinator.Infrastructure.csproj --startup-project src/SyncCoordinator.Worker/SyncCoordinator.Worker.csproj
Remove-Item Env:SYNC_COORDINATOR_DESIGN_CONNECTION

本番運用前の確認