Sunix Installation Guide

Step-by-step guide to install Your Booking for a practice on Sunix Vision.

Overview

Your Booking is an online appointment booking system for optometry practices using Sunix Vision. A lightweight agent runs on your practice server, reads from and writes to your existing Sunix data files, and connects securely to the Your Booking platform. No patient data is stored outside your practice.

Prerequisites

No Sunix Vision changes required. The agent reads and writes Sunix's data files directly. Sunix doesn't need to be reconfigured, doesn't need to be running, and doesn't need to be stopped during installation. Staff can keep using Sunix Vision throughout.

Mapped drive letters will not work. The agent runs as a Windows service. Drive mappings like V: or Z: belong to a signed-in user, not to services — a service simply cannot see them. If you give the agent V:\v2k\Data it installs cleanly and reports Online, but every attempt to read your data fails. Use a local path (C:\…) or a full network path (\\SERVER\share\…), never a mapped letter.

Step 1: Choose the machine, then find the folders

The agent needs two Sunix folders: the Vision folder (contains v2000.exe) and the Data folder (contains the .dbf and .cdx data files). Where those folders live decides how you install.

1.1 Which machine to install on

Option A — install on the machine that holds the Sunix data. Recommended wherever it's possible. On most practices that's the server; if Sunix runs on a single standalone PC, it's that PC. Every path is a local C:\ path, the service needs no extra configuration, and reads and writes are as fast as they can be.
→ Follow Section 1.2, then Step 2. Section 2.5 does not apply to you.

Option B — install on another PC on the network. Use this when the Sunix data lives on a NAS, or on a machine you can't install software on. The agent then reaches the data across the network, which needs two extra things, neither of them optional: full network paths (Section 1.3) and a service log-on account (Section 2.5). Every read and write crosses the network, so it is slower than Option A.
→ Follow Section 1.3, then Step 2, then Section 2.5. This option is best handled by whoever looks after the practice's IT.

1.2 Option A — folders on this machine

Sunix Vision folder — the folder containing v2000.exe, the main Sunix Vision program. Common locations are C:\v2k, D:\v2k and C:\Sunix\v2k. The installer tries to auto-detect it. To find it yourself, right-click the Sunix Vision shortcut on the desktop and choose Open file location.

Sunix Data folder — almost always a subfolder called Data under the Vision folder, for example C:\v2k\Data. The installer pre-fills this for you from the Vision folder. Opened in Windows Explorer it contains a large number of files; that's the right folder.

If your data folder is somewhere else on the same machine, browse to its actual location.

1.3 Option B — folders on another machine

Both folders must be entered as full network paths in the form \\SERVER\share\folder, even when the same folder appears as a mapped drive letter on your desktop.

Find the network path. Right-click the Sunix Vision shortcut on a PC that runs Sunix and choose Properties. The Target and Start in fields show the path Sunix itself uses:

Drive mappings are per user. Signed in as an administrator, net use lists your mappings, not those of the staff account that runs Sunix — the Sunix drive letter may not appear at all. If that happens, get the share path from whoever manages the server rather than guessing.

Choose the account the service will run as. You'll need its username and password in Section 2.5. It has to satisfy both of these:

  1. Read and write access to the Sunix share. Read alone is not enough — the agent writes appointments back into Sunix.
  2. Local administrator on the machine the agent is installed on. The agent updates itself: it downloads the new build, runs the installer, and restarts its own Windows service. All of that needs administrator rights, and it runs as the service account, not as you. Without them the agent keeps working but silently stops taking updates — including fixes.

An ordinary staff login usually satisfies (1) and fails (2). If the account that reaches the share isn't an administrator on this machine, either add it to the local Administrators group, or create a dedicated account that is both — a service account belonging to the practice, with a password that isn't rotated with staff passwords, is the tidier answer.

Confirm the share access before installing, from a command prompt:

runas /user:SERVER\thataccount cmd

Then in the window that opens:

dir \\SERVER\vision\v2k\Data
echo test > \\SERVER\vision\yb_test.txt
del \\SERVER\vision\yb_test.txt

All three must succeed. (Write the test file to the share root as shown, not into the Sunix data folder.)

Step 2: Install the Agent

2.1 Download and run the installer

Download the installer from:

https://yourbooking.au/downloads/YourBookingAgent-Sunix-Setup.exe

Run it on the chosen machine.

2.2 Choose install location

The default location is C:\Program Files\YourBookingAgent-Sunix. You can change this if needed. (The Optomate flavour installs to a separate folder, so both can coexist on the same machine if you ever migrate.)

2.3 Enter practice details

The installer will prompt for:

SettingDescription
Licence KeyYour practice licence key (provided during onboarding)
Sunix Vision folderFolder containing v2000.exe (Section 1.2 or 1.3). The installer pre-fills this if it can find Sunix automatically.
Sunix Data folderFolder containing your Sunix data files. Pre-filled as <Vision folder>\Data.

Installing on another machine (Option B): type the full network paths from Section 1.3 into both fields. Don't accept an auto-detected C:\v2k — that would be this PC's own folder, not the practice's data. And don't type a mapped drive letter, even though it works when you browse to it; see the warning in Prerequisites.

The installer validates both folders before it lets you continue — it'll tell you if v2000.exe is missing from the Vision folder or the data folder doesn't exist. Note that it checks this as you, the signed-in user. A network path that passes here can still be unreachable to the service, which is what Section 2.5 fixes.

2.4 Complete installation

The installer will:

2.5 Network installs only — set the service log-on account

Skip this if you installed on the machine that holds the Sunix data (Option A).

By default a Windows service runs as LocalSystem, which reaches network shares as the computer, not as a user. Most file servers and NAS boxes refuse that. Once the installer has finished:

  1. Open services.msc (press Windows+R, type services.msc, press Enter).
  2. Find Your Booking Agent (Sunix), right-click it and choose Properties.
  3. Go to the Log On tab, select This account, and enter the account and password from Section 1.3 — the one with share access and local administrator rights.
  4. Click OK, then right-click the service and choose Restart.
  5. Check the log for a clean start with no access errors:
    type "C:\Program Files\YourBookingAgent-Sunix\logs\winsw.err.log"

Two things to keep in mind afterwards:

The Log On setting itself survives agent updates — it only needs setting once.

Step 3: Verify

Open your practice's booking page (e.g. yourpractice.yourbooking.au) in a browser.

Step 4: Set Up Your Booking

Once the agent is installed and connected, follow the Setup Guide to configure the booking system. This covers:

Online booking is off by default, so you can take your time configuring everything before patients can see the booking page.

Appointment types come from Sunix. Your Booking reads your existing Sunix appointment-type list automatically — you don't need to mark types as "available for online booking" inside Sunix. You'll choose which types appear online from the Your Booking admin instead.

For how Your Booking reads your Sunix appointment slots — controlling availability, blocking days off, and choosing which optometrists patients can book — see Configuring Appointments (Sunix). Common "why is that showing online?" questions are answered in the FAQ.

Optional: send patient emails from your own address

By default, patient emails (booking confirmations, reminders, recalls, follow-ups) come from bookings@yourbooking.au with your reception address as the reply-to. To have them come from your own address instead — either by adding DNS records to your domain, which needs no password, or by sending through your own Gmail or Outlook account — see the Practice Branded Email guide.

Step 5: Add to Your Website

To embed the booking page on your website, see the Website Integration Guide. It covers the iframe embed code, configuring email links, and optional redirect rules for SMS/recall links.

In-store kiosk (iPad)

Set up a tablet in the waiting room so patients can book themselves when staff are busy.

  1. Open https://yourpractice.yourbooking.au/?kiosk in Safari on the iPad
  2. Tap Share (square with arrow) then Add to Home Screen
  3. Name it (e.g. "Book Appointment") and tap Add

The app launches full-screen with no browser chrome. It shows a welcome screen with the practice logo and a "Book an Appointment" button. After a booking completes or 2 minutes of inactivity, it resets back to the welcome screen for the next patient.

iPad setup for shared use:

Disable autofill so patients don't see each other's saved information:

Add to phone home screen

Patients can add the booking page to their own phone's home screen by visiting https://yourpractice.yourbooking.au/ directly and choosing "Add to Home Screen". This gives them a branded app icon and a full-screen booking experience. If you've uploaded a square icon in Branding → Square icon, that's used for the home-screen icon — otherwise your main logo is used (which may look cropped on square icon slots).

Patients who visit the booking page via your own website (the embedded iframe) need the additional manifest setup described in the Website Integration GuideStep 4: Add to Home Screen to get the same experience.

Firewall

The agent only makes outbound connections. No inbound firewall rules or port forwarding are required.

If your network has outbound filtering, ensure the server can reach:

Changing Configuration

To change the Sunix folder, data folder, or other settings:

  1. Edit the .env file in the install directory (e.g. C:\Program Files\YourBookingAgent-Sunix\.env)
  2. Restart the service using one of:
    • Windows Services: open services.msc, find "Your Booking Agent (Sunix)", right-click → Restart
    • Command line: open a command prompt as Administrator in the install directory and run winsw restart

Logs

Agent logs are at logs\winsw.err.log in the install directory. To view:

type "C:\Program Files\YourBookingAgent-Sunix\logs\winsw.err.log"

Log files rotate automatically at 5MB.

Service Management

The agent runs as a Windows service called YourBookingAgentSunix (displayed as "Your Booking Agent (Sunix)" in the Services console). You can manage it from the Windows Services console (services.msc) or from the command line:

winsw start
winsw stop
winsw restart
winsw status

Run these from the install directory (e.g. C:\Program Files\YourBookingAgent-Sunix).

Uninstalling

Use Add or Remove Programs in Windows Settings, or run the uninstaller from the Start Menu. This stops the service, removes it from Windows, and deletes all installed files. Your Sunix data is untouched.

Troubleshooting

Agent won't start

"Agent Connected, But Cannot Read Your Data"

What you see: a red banner across the top of the admin dashboard with that heading, naming the folder the agent couldn't read. Pages that need information from Sunix — appointment types, optometrists, the appointment list — don't load.

What it means: the agent is connected to Your Booking, but it cannot read your Sunix data. Those are two separate things, which is why the booking page header still shows a green Online dot.

The banner states the specific cause and is usually enough on its own. On older agent versions the same fault has no banner and shows only as a server error (500) on those pages — the causes below are the same either way.

Open the .env file in the install directory (C:\Program Files\YourBookingAgent-Sunix\.env) and look at SUNIX_DATA_PATH and SUNIX_VFP_HELPER_PATH. In order of likelihood:

  1. The path starts with a mapped drive letter (V:\…, Z:\…). The service cannot see mapped drives — see the warning in Prerequisites. Replace both with full network paths (Section 1.3) and restart the service.
  2. The service is still running as LocalSystem against a network share. Do Section 2.5.
  3. The service account has read access but not write. Booking pages load, then every booking fails. Confirm with the runas test in Section 1.3.
  4. A typo in the path, or the folder has since moved.

The log tells you which. Run:

type "C:\Program Files\YourBookingAgent-Sunix\logs\winsw.err.log"

After any change, restart the service (services.mscYour Booking Agent (Sunix) → Restart) and reload the admin page.

The agent isn't picking up updates

The agent installs its own updates and restarts its own Windows service, which needs administrator rights. If you changed the service to run as a specific account (Section 2.5) and that account is not a local administrator on this machine, updates fail silently — the agent keeps running the version it already has, and nothing on the dashboard says so.

Check the account on the Log On tab in services.msc, then confirm it's in the machine's local Administrators group. Restart the service after adding it.

Booking page shows "agent offline"

Booking shows "temporarily unavailable"

Sunix shows old data after a booking