Skip to content

Installing SQL Agent on Windows

Server Selection

Note: The SQL Agent can be installed on Linux or Windows. For best performance and throughput the ideal and recommended solution is to install it on the same system that hosts the SQL Server database.

Installation

Installing SQL Agent on a Windows target system involves downloading and running a Windows MSI installer. The installation can be downloaded from the Synergex Resource Center.

The name of the installation file will be as shown below, where n.n.n.n is the version number of the product you have downloaded:

Windows SQL Agent installer
Synergex-SIP-SQLAgent-n.n.n.n.msi

Executing the installation requires administrator privileges.

The product will be installed into the directory C:\Program Files\Synergex\SIP\json-agent.

Configuration

TODO: More information needed here.

SQL Server 2022 Time Processing

When implementing SQL Replication using the SQL Agent, part of the preparation and deployment involves the generation of custom code that is used to interact with the SQL Server tables. This custom code understands the fields and data types used in your application and is responsible for transposing that information to appropriate SQL Server column date types.

In SQL Server 2022, the PolyBase environment did not correctly process time fields (HH:MM and HH:MM:SS) when processing data from parquet data sources, and we had to work around the problem in the generated SQL code. Microsoft corrected the issue in SQL Server 2025, but this was a breaking change that we once again had to code our way around.

By default, the SQL Agent environment is configured with the assumption that SQL Server 2025 (or later) will be used. If SQL Server 2022 is being used, and the application data files contain time fields in replicated files, you must set the Sql2022TimeProcessing property in the Database section of the master configuration file (MasterConfig.json) before starting the SQL Agent application.

Service Management

TODO: More information needed here.

Upgrades

To upgrade the SQL Agent to a new version:

  • Review the release notes for the new version so you're aware of any prerequisite tasks or tasks that must be completed after the upgrade.
  • Download the installer for the new version and copy it to the target system.
  • Make sure you still have the installer for the version you're currently running, in case you need to revert to that version for any reason. If you don't have it, you can download it from to be determined.
  • Perform any prerequisite tasks as defined in the release notes.
  • When you're ready to perform the upgrade, stop the SQL Agent service.
  • Execute the installer to perform the upgrade.
  • Perform any post-upgrade tasks as defined in the release notes.
  • Restart the SQL Agent service.

Removal

To remove the SQL Agent from a Windows target system:

  • Make sure the SQL Agent service is not running.
  • Use either Installed Apps in the Windows Settings App or Programs and Features in the Windows Control panel to remove the product from the system. Look for the product name Streaming Integration Platform SQL Agent.