Skip to content

Installing JSON Agent on Windows

Server Selection

Note: The JSON Agent can be installed on Linux or Windows.

Installation

Installing the JSON 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 JSON Agent installer
Synergex-SIP-JSONAgent-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

During the installation you will be prompted to enter three pieces of information:

  • JSON Agent port (required, default is 5128)
  • Default profile name to create/use (required, default is default)
  • Configuration Server URL (optional)

If you're using Configuration Server in your environment, it should be installed and started, and your profile's configuration files should be fully configured before installing or starting other components.

Service Management

JSON Agent runs as a Windows service and will be configured to run under the unprivileged NetworkService account and to be started automatically during system boot.

The Windows service is named sip-json-agent and can be controlled via all of the normal Windows service management tools.

Upgrades

To upgrade the JSON 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 Synergex Resource Center.
  • Perform any prerequisite tasks as defined in the release notes.
  • When you're ready to perform the upgrade, stop the JSON Agent service.
  • Execute the installer to perform the upgrade.
  • Perform any post-upgrade tasks as defined in the release notes.
  • Restart the JSON Agent service.

Removal

To remove the JSON Agent from a Windows target system:

  • Make sure the JSON 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 JSON Agent.