S4 - Install the On-Prem Multi-Source Agent

Extended Page Title

Step 4 - Install the CI Sync On-Premise Multi-Source Agent


Task #

Task

Performed by

1

Create a Windows Service Account for the CI Sync Agent to use

Infrastructure SME

2

Configure the Windows Service Account

Infrastructure SME

3

Download the CI Sync Multi-Source Agent from the CI Sync SaaS UI

Infrastructure SME

4

Run the CI Sync Agent installer wizard

Infrastructure SME


Click to expand Guidance Notes related to Step 4 (and later for Step 5)

Syncfish recommends you decide at this point whether to use a Local Windows Account or AD Domain User Account as the Service Account for the CI Sync Agent Windows Service.

We also recommend you decide which authentication type (either Integrated Security vs SQL Native Login) will be used to authenticate between the CI Sync Agent and your SQL Server.  The CI Sync Agent uses a SQL Server for two purposes:

  1. For read/write access to the RecVer database.  The RecVer database is the CI Sync Agent’s delta record tracking SQL DB.

  2. For read access to synchronization data sources for products such as Lansweeper and SCCM.

Pros and cons about using a Local Windows User Account as the Service Account

  • A Local Account can be quickly created by the person performing the CI Sync Agent installation.

  • A Local Account cannot be used as the SQL authentication account if SQL Server is running on a separate server to the CI Sync Agent. That is, a Local Account cannot be used for “Integrated Security” login to a remote SQL server.  If your SQL Server is remote to the CI Sync (Agent) server then you need to do one of the following:

    • Either run the CI Sync Agent (i.e. the Windows Service) with an AD Domain User Account

    • Or, run the CI Sync Agent (i.e. the Windows Service) using a Local Windows User Account and then use a SQL Native Login credential for the remote SQL Server when you add your Source Connection(s) during S5 - Register the Multi-Source Agent & Setup Source Connections later in these setup guides.

Pros and cons about using an AD Domain User Account as the Service Account

  • An AD Domain User account can be used as the authentication account to a remote SQL server.

  • An AD Domain User account often needs to setup by a separate team.


Task 1: Create a Windows Service Account for the CI Sync Agent to use

Option 1: Use a Local Windows Service/User Account

Expand the instructions below if you are using a Local Windows Service/User Account on the VM that will have the CI Sync Agent installed.

Click to expand the instructions
  1. Login to the console of the Server/VM using an account that has Local Administrator rights.

  2. Navigate to Computer Management -> Local Users and Groups -> Users

image-20250327-060541.png
  1. From the Action menu select New user… and do the following:

    1. Enter the User name (e.g. svc-cisync-agent)

    2. Enter the Full name (e.g. see screen shot)

    3. Enter the Password

    4. Confirm the Password when prompted

    5. It is recommended to set the checkbox values shown below (or amend to your company policy)

    6. Click the Create button

    7. Add the user to the “Users” group.

The user needs to be in the Users group only. It does not need to be in any elevated groups.


Data Capture Summary

As a reminder, you should have captured the following information when completing the above steps.

  1. The Service Account Username (from Step 2a directly above).

  2. The Service Account Password (from Step 2c directly above).

Make sure the password is stored securely and in a way that can be shared with the CI Sync Admin so they can use it when the follow the instructions later on during S5 - Register the Multi-Source Agent & Setup Source Connections.

Option 2: Use an AD Domain Service/User Account

Expand the instructions below if you are using an AD Domain Windows Service/User Account for the CI Sync Agent.

Click to expand the instructions
  1. Login to your Active Director domain and use the Users and Computers MMC to create a domain user account. 

  2. Create the account according to your company standards for a Service Account (e.g. svc-cisync-agent or something similar).

The user requires domain user privileges (i.e. be a member of the Domain Users Group).  It does not require any elevated permissions.


Data Capture Summary

As a reminder, you should have captured the following information when completing the above steps.

  1. The Service Account Username (from Step 2 directly above).

  2. The Service Account Password (also from Step 2 directly above).

Make sure the password is stored securely and in a way that can be shared with the CI Sync Admin so they can use it when the follow the instructions later on during S5 - Register the Multi-Source Agent & Setup Source Connections.


Task 2: Configure the Windows Service Account

Perform the following steps on the server that will run the CI Sync Agent.

  1. Run secpol.msc

image-20250327-061724.png
  1. Navigate to Local Security Policy

CleanShot 2025-04-03 at 16.17.41@2x-20250403-051746.png
  1. Navigate to Local Policies -> User Rights Assignment and double-click the Log on as a service list entry

CleanShot 2025-04-03 at 16.18.04@2x-20250403-051809.png
  1. Click Add User or Group and enter the name of the user created above (either the AD Domain User Account or a Local Windows User Account)

  2. Click Check Names

  3. Click OK

Picture 1.png
  1. Click Apply and OK

CleanShot 2025-04-03 at 16.18.40@2x-20250403-051844.png

Task 3: Download the CI Sync Multi-Source Agent from the CI Sync SaaS UI

  1. Login to your CI Sync SaaS instance at https://YourCo.syncfish.app

  2. In the CI Sync UI, navigate to Settings > Connections.

  3. Click the “Download” next to the Source Connections list.

image-20250327-062050.png
  1. Use the drop down list and select the “Multi-Source” option to select the CI Sync Multi-Source Agent described in these instructions, and then select the Download button.

image-20250327-062228.png

Guidance Note

The options presented in the drop down list are based on the CI Sync licence allocated to your organization.  Please contact Syncfish if you do not see the “Multi-Source” option.

If you see just “Lansweeper” in the dropdown list this refers to the original “single-source” CI Sync Agent.  Do not select the “Lansweeper” option if wanting to download/use the new “Multi-Source” agent described in these instructions.


Task 4: Run the CI Sync Agent installer wizard

Perform the following steps on the server that will run the CI Sync Agent.

  1. Run the CI Sync Agent installer to commence the installation.

image-20250327-062327.png
  1. Click Next and change (if desired) the Service Display Name and Description

image-20250327-062340.png
  1. Click Next

  2. Enter the name for the Service Account created during Task 4a: Create a Windows Service Account for the CI Sync Agent to use. (either the Local Windows User Account or the AD Domain User Account).

    1. If using a domain account, enter the AD Domain in the first field and the username in the next field.

    2. OR, If using a local account, leave the first field (Domain) blank and just enter the local user account the second field (e.g.  svc-cisync-agent).

    3. Enter the password for the account

image-20250327-062350.png
  1. Click the Next button

  2. At Select an Installation Folder, change if required, and click Next

image-20250327-062358.png
  1. Click Install on the Ready to Install prompt

image-20250327-062405.png

 8. Wait for the installation to complete (several minutes).

image-20250327-062412.png
  1. Click Finish.

  2. Upon completion the CI Sync Agent Config Utility will be automatically launched.

Instructions for using the CI Sync Agent Config Utility are in S5 - Register the Multi-Source Agent & Setup Source Connections