Installing the Sync Agent on a Windows server

Customers that wish to connect Intellischool services to an on-prem data source must install our Sync Agent on a local server

➡️ Select/configure an internal server for the agent

The server that you install the Sync Agent on must meet our minimum system requirements. We recommend, where possible, to use a server configured solely for the Intellischool agent. However, you may co-locate the agent on another server if this is impractical.

➡️ Configure a service account

We recommend configuring a service account that the agent should run as. If you're running Windows Server 2022 or earlier, you can use a standard local user account as your service account. If you're using Windows Server 2025 the most appropriate type of service account to use is a Standalone Managed Service Account.

Refer to Microsoft's documentation if you are unsure about how to create a local user account on a server.

Note down the username and password that you have assigned to the account, as you will need this information later.

Once you have created your service account, ensure that it has the Log on as a service right assigned in your server's local policy manager.

➡️ Add environment variables

Before starting these steps, ensure that you have your sync deployment credentials from our support team.

The commands below will store your Sync Agent's credentials in a user-scoped environment variable, accessible only by the service account that you created in the previous step.

1. Open a command prompt as an administrator.
2. Enter the following commands, substituting the text in <angle brackets> (remove the angle brackets as well):
   

   1. setx /u <service_username> /p <service_password> INTELLISCL_SYNC_DEPLOYMENT_ID <deployment_id>

   2. setx /u <service_username> /p <service_password> INTELLISCL_SYNC_DEPLOYMENT_SECRET <deployment_secret>

3. [OPTIONAL] If you wish to specify a specific temporary storage location for the agent, run the command below. You must ensure that the agent service account has appropriate permissions for the temporary folder.

   1. setx /u <service_username> /p <service_password> INTELLISCL_SYNC_TEMP_FOLDER <folder_path>

4. [OPTIONAL] If you are using a proxy server to communicate with the Internet, you can specify it by running the command below.

   1. setx /u <service_username> /p <service_password> INTELLISCL_SYNC_PROXY <hostname>:<port>

➡️ Install the agent

As of June 2023, the Sync Agent has been incorporated into the Intellischool CLI. You can download the most recent version of the CLI from our CLI Quickstart guide.

Once you have installed the CLI, reboot the server.

➡️ Test connectivity

1. Log in to your sync agent server with the service account credentials you created earlier.
2. Open a command prompt.
3. Enter the command intelliscl sync.

If you receive a message stating that the sync has been completed successfully, you can move on to the next step.

If you receive an error message, contact our support team for assistance in rectifying the issue.

➡️ Set up regular sync

The Sync Agent should poll Intellischool's systems on a regular basis to see if there are any data synchronisation jobs waiting to be completed. We recommend polling our systems every 5 minutes, but you can choose to poll less frequently if you wish.

We recommend using the Windows Task Scheduler to configure regular polling.

Configure your task as follows:

• Run as the service account you configured earlier
• Start at 12.01am daily, and configure to randomly delay the start by up to 2 minutes
• Execute every 5 minutes for a period of 24 hours / 1 day
• Execute the following task - note that you may need to update the path if you selected an alternative installation location:
  C:\Program Files\Intellischool\intelliscl\bin\intelliscl.cmd
• Add the following arguments to the task execution:
  sync

➡️ Update your onboarding specialist

Once you have completed the steps above, please let your onboarding specialist know so that we can monitor and test your deployment.

If there are any issues with the deployment we'll reach out to help sort them out.