Install on Windows

Before you start

• A pairing code or pairing command from the Agents page (ask an admin for it).
• Network access from this machine to your database server.
• A read-only database login, if you already have one — otherwise the setup can generate a script for your DBA to create one.
• Windows 10 / Server 2016 or newer recommended. Windows Server 2012 R2 is supported best-effort and needs .NET Framework 4.8 — the installer checks for this and tells you if it's missing. If the .NET Framework 4.8 installer refuses to run, install Windows Update KB2919355 first, restart, then try again. Alternatively, install the agent on any newer Windows machine on the same network that can reach your SQL Server.

Install

1. Download and double-click NiaCoreGateway-Setup-<version>.exe from the downloads page.
2. Approve the single admin prompt, choose an install folder (or accept the default), and click through to Finish. Leave "Set up now" checked.
3. The guided setup opens automatically in a console window — answer its questions below.

That's it. The agent installs as a Windows service, running under its own restricted account (not an administrator), and starts automatically from then on. Find "Nia Core Gateway (advanced) - Setup" and "Nia Core Gateway (advanced) - Status" in the Start Menu any time you need to run the wizard again or check in.

Guided setup questions

1. Pairing command or code — paste the full command from the Agents page, or just the code.
2. Database server and port (default 1433). If it detects SQL Server instances on this machine, it lists them first and picking one (pressing Enter takes the first) is the default — localhost is offered last, as a fallback if none are detected or none match.
3. Database username — leave blank if you don't have one yet, and it offers to write a read-only setup script for your DBA instead.
4. Database password (hidden as you type).
5. Pick a database from a numbered list of what that login can see.
6. Time zone the database server runs in (defaults to this machine's own).
7. Destination hostname to allow (optional — only needed if a job will be published from a Nia Core workflow rather than added directly on this machine).

It then starts the service, waits for a successful check-in, and prints a summary. Run the wizard again any time from the Start Menu shortcut — once already set up, it shows a small menu instead (add another database, test a database, allow a destination, show status, exit).

Verify it worked

Open the Agents page on Nia Core — the agent should show up as online within a few seconds of finishing setup. On the machine itself, run nia-agent status for how long it has been running, whether it is paired, when it last checked in, and the health of each job.

Uninstall

Use Settings → Apps → Nia Core Gateway → Uninstall — it asks whether to keep or delete the agent's stored configuration.

Advanced: typed-command install

Everything the guided setup does can also be done by hand — useful for scripted or unattended installs. Install without the guided setup with:

powershell -ExecutionPolicy Bypass -File install.ps1

run as Administrator from the unzipped bundle folder. This does not start the agent — run Start-Service nia-agent afterward. Then, in order:

nia-agent sql readonly --login nia_agent --databases <your-database-name> --out nia-readonly-setup.sql

nia-agent pair --code <pairing-code> --url <platform-address>

nia-agent connection add \
  --id <short-id> --label "<friendly name>" \
  --host <database-server-host> --port <port> --database <database-name> \
  --user nia_agent --password <the-password> \
  --source-timezone <IANA time zone, e.g. America/New_York>

nia-agent destinations allow <destination-hostname>

nia-agent status

The read-only setup script creates one login with a placeholder password your DBA replaces, grants it read access plus the ability to see table/column definitions, and grants no write access of any kind — enforced automatically. Confirm a connection works with nia-agent connection test <short-id>.