メインコンテンツまでスキップ

ローカル Sync Client

概要​

Sync Client は、SDA Console のプロジェクトをローカルコンピューターまたはネットワーク共有上で利用可能な状態に保つためのデスクトップアプリケーションです。バックグラウンドサービスとともに動作し、プロジェクトの選択、バージョンの同期、編集のためのチェックアウト、変更のチェックインを行うウィンドウを提供します。

アプリケーションのワークフローは Windows と Linux で共通です。インストールおよび削除についてはプラットフォーム固有の手順を示し、その他のスクリーンショットは共通のインターフェイスを示しています。

ダウンロード​

ご使用のオペレーティングシステム向けの最新パッケージをダウンロードしてください。

Sync Client のインストール​

Windows​

  1. ダウンロード フォルダー内の sync-client-windows-setup.exe を右クリックし、管理者として実行 を選択します。管理者権限が必要です。

    Windows インストーラーを探す

    Windows インストーラーを管理者として実行する

  2. ようこそ画面から続行します。

    Sync Client セットアップのようこそ画面

  3. インストール先フォルダーを選択します。既定の場所を推奨します。

    インストール先フォルダーを選択する

  4. デスクトップショートカットや自動起動を含む、利用可能なコンポーネントを選択します。

    Windows のインストールコンポーネントを選択する

  5. Run Sync Client を選択したまま、Finish を選択します。

    Windows のインストールを完了する

Linux​

  1. sync-client-linux.tar.bz2 をダウンロードして展開します。

    tar -xjvf sync-client-linux.tar.bz2

  2. 展開したディレクトリでターミナルを開きます。

    cd sync-client-linux

  3. 管理者権限でインストーラーを実行します。

    sudo ./install.sh

    Linux に Sync Client をインストールする

  4. ターミナルに Installed Sync Client と表示され、インストールされたバンドル、CLI、デスクトップエントリ、サービス、サービスユーザーが一覧表示されることを確認します。インストールが完了すると Sync Client が自動的に起動します。

  5. Sync Client を使用する前に、Linux デスクトップからログアウトして再度ログインしてください。 インストーラーはデスクトップユーザーを sync-client グループに追加し、新しいグループメンバーシップは新しいログインセッションで有効になります。

  6. 再ログイン後、Sync Client がまだ実行されていない場合は、アプリケーションランチャーまたはシステムトレイアイコンから開くことができます。

    Linux のアプリケーションランチャーから Sync Client を開く

初回設定​

初回セットアップは次の順序で自動的に進行します。

Login → Storage → Filters / Policy

以下のスクリーンショットは Windows 版のものですが、同じ設定と操作は Linux でも利用できます。

サインイン​

SDA Console のメールアドレスとパスワードを入力し、API URL を確認して Connect を選択します。

SDA Console にサインインする

各フィールドの横にあるアイコンは、それぞれの値が検証されたかどうかを示します。接続に成功すると、Sync Client は自動的に Storage ステップを開きます。

検証済みの SDA Console アカウント

多要素認証​

アカウントで多要素認証が有効になっている場合は、認証アプリケーションに表示される 6 桁のトークンを入力し、Confirm を選択します。

多要素認証トークンを入力する

ストレージの選択​

Sync Client は、同期したプロジェクトをローカルフォルダーまたは SMB ネットワーク共有に保存できます。

ローカルファイルシステム​

Local Filesystem を選択し、Browse でプロジェクトフォルダーを選択し、同期間隔を設定して Save を選択します。

ローカルのプロジェクトストレージを設定する

SMB ネットワークストレージ​

Network Location を選択し、次の項目を指定します。

  • UNC Path: ネットワーク共有と任意のサブフォルダー（例: \\fileserver\engineering）
  • Domain: 必要な場合の Windows ドメインまたはワークグループ
  • SMB Username および SMB Password: 読み取りおよび書き込み権限を持つアカウント
  • Sync Interval: Sync Client がプロジェクトの更新を確認する頻度

SMB ネットワークロケーションを設定する

Save を選択して設定を検証し、適用します。ストレージ設定が保存されると、Sync Client は自動的に Filters / Policy を開きます。

プロジェクトとバージョンの選択​

Filters / Policy を使用して、同期するプロジェクトと、ローカルに保持するバージョン数を選択します。

フィルターを使用してプロジェクトを選択する

  • IDE、Vendor、Groups、Time Range を使用してプロジェクト一覧を絞り込みます。
  • プロジェクトツリーを名前で検索します。
  • グループを展開し、グループ全体または個々のプロジェクトを選択します。
  • 有効なフィルターは、そのピルを選択することで削除できます。

Version policy では、Last N versions を選択すると、最近のバージョンを一定数だけ保持します。

最新のプロジェクトバージョンを保持する

または Since date を選択して、指定した日付以降に作成されたバージョンを保持します。

ローカルバージョンポリシーを設定する

Apply を選択し、有効なフィルター、選択されたプロジェクト、保持ルール、および古いローカルバージョンが削除されるかどうかをまとめた確認内容を確認します。

同期ポリシーを確認する

プロジェクトの操作​

プロジェクトの検索と同期​

Projects を開き、検索、All、または Groups を使用してプロジェクトを見つけます。プロジェクトを選択すると、利用可能なバージョン、タイムスタンプ、IDE 情報、ローカルパス、コミットメッセージ、同期状態が表示されます。

同期されたプロジェクトバージョンを参照する

設定された間隔を待たずに即時同期を要求するには、Sync now を使用します。

プロジェクトのチェックアウトと起動​

プロジェクトのバージョンを選択し、Checkout を選択します。確認前に任意のロックメッセージを追加できます。

プロジェクトのチェックアウトを確認する

チェックアウトが完了すると、そのプロジェクトは作業用にロックされます。プロジェクトビューにはチェックアウトされたバージョンが表示され、Open project、Checkin、Discard checkout が有効になります。

チェックアウトしたプロジェクトを操作する

Open project を選択すると、そのプロジェクトタイプに登録されているエンジニアリングアプリケーションでローカルのチェックアウトが開きます。対応する IDE がコンピューターにインストールされている必要があります。

Sync Client はまず登録済みのエンジニアリングアプリケーションを起動し、その後チェックアウトしたプロジェクトを開きます。

エンジニアリングアプリケーションを起動する

エンジニアリング IDE で開かれたチェックアウト済みプロジェクト

変更のチェックインまたは破棄​

編集後、Sync Client に戻り Checkin を選択します。変更内容を説明するメッセージを入力して確定します。

チェックインの前に、外部のエンジニアリング IDE を閉じてください。 IDE が開いたままだと、チェックアウト内にプロジェクトのロックファイルが残り、Sync Client がチェックインを準備できなくなる場合があります。

プロジェクトのチェックインメッセージを入力する

Sync Client は変更されたプロジェクトをアップロードし、新しいバージョンをバージョン履歴に追加して、プロジェクトのロックを解除します。

チェックイン成功後のプロジェクト

ローカルの変更を破棄する場合は、Discard checkout を選択して確定します。

お気に入りプロジェクト​

プロジェクトの横にある星を使用して、Favorites に追加または削除します。塗りつぶされた星はお気に入りプロジェクトを示し、プロジェクト一覧からより素早くアクセスできます。

プロジェクトをお気に入りに設定する

お気に入りのマークは、グループ化されたプロジェクトツリーでも表示されます。

グループ化されたプロジェクトツリー内のお気に入りプロジェクト

ヘルプと診断​

Export logs を使用して、サポート用の診断パッケージを作成します。エクスポートにはアプリケーションログとサービスログが含まれますが、保存されたパスワードは含まれません。

Sync Client のログをエクスポートする

About を開くと、インストールされているアプリケーションのバージョン、ライセンス情報、サードパーティ通知を確認できます。

Sync Client の情報を表示する

Sync Client はシステムトレイで実行を継続できます。トレイメニューからアプリケーションを開く、状態を確認する、終了するといった操作が行えます。

Sync Client のシステムトレイメニュー

コマンドラインインターフェイス​

インストールにより sync-cli も提供されます。これはデスクトップアプリケーションと同じバックグラウンドサービスと通信します。

サービスと同期の状態を確認します。

sync-cli --status

現在の非機密設定を表示します。

sync-cli --show-settings

即時同期を要求します。

sync-cli --sync-now

アクティブなプロジェクトのチェックアウトを一覧表示します。

sync-cli --show-checkouts

サポートされているすべてのプロジェクトオプションおよび出力オプションを確認するには、sync-cli --help を実行します。スクリプトからコマンド出力を利用する場合は --json を追加します。

Sync Client のアンインストール​

Windows​

まずシステムトレイから Sync Client を終了します。次に Windows の アプリ または プログラム を開き、Sync Client を選択して、アンインストールの指示に従って完了します。

Windows のアンインストーラーを開始する

Windows で削除を確認する

Windows のアンインストールを完了する

Linux​

  1. アンインストーラーを実行する前に、システムトレイメニューから Sync Client を終了します。

  2. 展開した sync-client-linux ディレクトリでターミナルを開きます。

  3. 管理者権限でアンインストーラーを実行します。

    sudo ./uninstall.sh

    Linux で Sync Client をアンインストールする

アンインストーラーは /opt/sync-client からアプリケーションバンドルを削除します。設定、同期されたデータ、ログは、後で再利用または調査できるように /etc/sync-client、/var/lib/sync-client、/var/log/sync-client に残されます。