Your
Booking
Documentation / Multi-Branch Installation

Multi-Branch Installation Guide

Installation steps for multi-branch practices. The process depends on how your Optomate is set up.

Which scenario are you?

Single database (one virtual server, all branches)
Your Optomate lists multiple branches in one database. All staff and appointment types are shared. This is the simpler setup — the agent is installed once and covers all branches.

Multiple databases (separate server per branch)
Each branch has its own Optomate server — either a local install at each location, or separate virtual servers. Each branch shows only one branch in Optomate. An agent is installed at each location.

Not sure? Open Optomate and check how many branches are listed. If you see all your locations, it's a single database. If you only see the current branch, each location has its own database.

Single Database Setup

One Optomate database with all branches. The agent is installed once on the server (or any machine that can reach the Optomate API). One licence key covers the whole business — every branch is served by the single agent install.

Prerequisites

Step 1: Configure Optomate Touch

  1. Open Optomate Touch
  2. Go to System Settings > API Access
  3. Click in the Username field, enter a username, then enter a password, an optional description, and then click Add
    • Username: e.g. YOURBOOKING (this appears as the staff code on appointments created by the booking system)
    • Note the username and password — you'll need these during installation
  4. Click Access List next to the new account you created, and enable:
ResourceReadCreateUpdate
AppointmentsYesYesYes
BranchesYes
Business DetailsYes
Online Appointment TypesYes
OptometristsYes
PatientsYesYesYes
SourcesYes

For Recalls & Reminders (can be enabled later):

ResourceReadCreateUpdate
Patient RecallsYesYes
Recall TypesYes
Patient NotesYesYes
  1. For every appointment type you use for patient appointments (not just the ones you plan to offer online, and including non-examination types such as spectacle collections and repairs): open the appointment type and tick "Available for Online Appointments". That tick is how Your Booking sees a type at all — including the collection type that Collections books into — and the same list is what appointment reminders, recalls and feedback requests work from. Ticking a type doesn't put it in front of patients: you choose which ones patients can book inside Your Booking.
  2. Create a patient source (recommended): go to Patient Settings > Sources, add a new source (e.g. "Online Booking"). This tags patients who register through the booking system so they're easy to identify in Optomate.
  3. Verify the API is accessible by opening this URL in a browser on the server:
http://localhost:12000/OptomateTouch/OData4/Branches

Because the browser sends no login details, you'll get a short "missing credentials" error, like this:

{"error":{"code":"100","message":"Missing Credentials!"}}

This is expected and confirms the API is running — you don't need to see your branch list here. If the page won't load at all ("can't connect" or it times out), the API isn't running: open Services (press Windows+R, type services.msc, press Enter), find Optomate API Service and make sure it is Running. If it isn't listed, the API isn't installed. Optomate Touch itself doesn't need to be open; the API runs separately.

Step 2: Install the Agent

  1. Download the installer: https://yourbooking.au/downloads/YourBookingAgent-Setup.exe
  2. Run it on the Optomate server
  3. Enter when prompted:
SettingValue
Licence KeyYour licence key (provided during onboarding)
Optomate ServerUsually just localhost — accepts hostname, host:port, or a full URL.
Optomate UsernameThe API username from Step 1
Optomate PasswordThe API password from Step 1
  1. The installer creates a Windows service that starts automatically. The agent connects to Your Booking and we auto-detect all your branches.

Step 3: Verify

Open your booking page (e.g. yourbusiness.yourbooking.au) in a browser.

Multiple Database Setup

Each branch has its own Optomate server. An agent is installed at each location.

Prerequisites (per branch)

Step 1: Configure Optomate Touch (at each branch)

Repeat at every branch — same steps, same permissions as the single database setup above (Step 1, points 1-7). Each branch gets its own API credentials.

Step 2: Install the Agent (at each branch)

  1. Download the installer: https://yourbooking.au/downloads/YourBookingAgent-Setup.exe
  2. Run it on the branch's server
  3. Enter when prompted:
SettingValue
Licence KeyThe licence key for this branch
Optomate ServerUsually just localhost — accepts hostname, host:port, or a full URL.
Optomate UsernameThe API username from Step 1
Optomate PasswordThe API password from Step 1
  1. The installer creates a Windows service that starts automatically. The agent connects and auto-detects the branch.

Step 3: Verify (per branch)

Repeat the check below for each branch's URL (e.g. branch1.yourbooking.au, branch2.yourbooking.au, …):

Direct Connection (advanced)

If your Optomate API is accessible over the internet (e.g. hosted with IIS and a public URL), the agent install can be skipped. Your Booking connects directly to the API. Contact support to set this up.

Your Booking checks the connection to each branch's Optomate every minute. If a branch's Optomate can't be reached, its booking page shows Offline (red dot) and patients can't book there until it's back. The offline alert email works as it does for an agent install: after 10 minutes, if Agent Offline Alerts is on in that branch's Setup page.

Firewall

Agents only make outbound connections. No inbound rules or port forwarding required. If outbound filtering is in place, allow:

Need Help Installing?

If you'd prefer, we can set up the Touch API and agent for you remotely via TeamViewer. Just let us know and we'll arrange a time.

Next Steps

Follow the Multi-Branch Setup Guide to configure appointment types, branding, and booking rules.

Changing Configuration

  1. Edit the .env file in the install directory (e.g. C:\Program Files\YourBookingAgent\.env)
  2. Restart the service: open services.msc, find "Your Booking Agent", right-click > Restart

Logs

Agent logs are at logs\winsw.err.log in the install directory. Log files rotate automatically at 5MB.

Service Management

The agent runs as a Windows service called YourBookingAgent. Manage it from Windows Services (services.msc) or from the command line in the install directory:

winsw start
winsw stop
winsw restart
winsw status

Uninstalling

Use Add or Remove Programs in Windows Settings, or run the uninstaller from the Start Menu.

Troubleshooting

Agent won't start

"Optomate authentication failed"

"Cannot reach Optomate"

Booking page shows "agent offline"