Installation Guide

Overview

Your Booking is an online appointment booking system for optometry practices using Optomate Touch. A lightweight agent runs on your practice server and connects securely to the Your Booking platform. No patient data is stored outside your practice.

Prerequisites

• Windows 10/11 or Windows Server 2016+
• Optomate Touch with the Touch API installed (version 2.12.11 or later, released 10/03/2026)
  • The API is a free download from Monkey Software
  • Download the "Optomate Touch Hosted x86 API" version (unless you already know you need the other one)
  • If you have an earlier version installed, download and install the latest version to update
• Internet access (outbound only — no inbound ports or firewall changes required)
• Your practice licence key (provided during onboarding)

Step 1: Optomate Touch Configuration

Before installing the agent, configure Optomate Touch for API access.

1.1 Create API credentials

1. Open Optomate Touch
2. Go to System Settings → API Access tab
3. Click New to create API credentials
   • Choose a username (e.g. YOURBOOKING) — this appears as the staff code on appointments created by the booking system
   • Set a password
4. Note the username and password — you'll need these during installation

1.2 Configure API access permissions

1. In the API Access tab, click Access List
2. Enable the following resources:

If you plan to use the Recalls & Reminders module (can be enabled later), also add:

1.3 Enable appointment types for online booking

1. Go to Appointment Types in Optomate
2. For each appointment type you want available online, tick Available for Online Appointments
3. Only types with this option enabled will appear in the Your Booking admin for configuration

1.4 Create a patient source (recommended)

1. Go to Patient Settings → Sources
2. Add a new source (e.g. "Online Booking")
3. This tags patients who register through the booking system, making them easy to identify in Optomate

1.5 Verify the API is accessible

Open a browser on the server and navigate to:

http://localhost:12000/OptomateTouch/OData4/Branches

You should see a JSON response with your practice branch details. If not, check that Optomate Touch is running and the API module is installed.

Step 2: Install the Agent

2.1 Download and run the installer

Download the installer from:

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

Run it on the practice server.

2.2 Choose install location

The default location is C:\Program Files\YourBookingAgent. You can change this if needed.

2.3 Enter practice details

The installer will prompt for:

2.4 Complete installation

The installer will:

• Copy all required files
• Create a Windows service (YourBookingAgent) that starts automatically on boot
• Start the agent and connect to the Your Booking platform

Step 3: Verify

1. Open your practice's booking page (e.g. yourpractice.yourbooking.au)
2. The page should load with your practice's branding
3. The agent status should show as online
4. Try viewing available appointment slots to confirm the connection to Optomate is working

Step 4: Set Up Your Booking

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

• Logging in to the admin dashboard
• Syncing appointment types from Optomate
• Configuring which appointment types are available for online booking
• Setting up optometrists, booking rules, and practice settings
• Enabling online booking when you're ready to go live

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

Optional: send patient emails from your own address

By default, patient emails (booking confirmations, reminders, recalls, follow-ups) come from obs@yourbooking.au with your reception address as the reply-to. If you'd rather have them come from your own domain (e.g. info@yourpractice.com.au) using your existing Google Workspace / Microsoft 365 / SMTP credentials, see the Practice Email Setup guide. IT may need to be involved for App Passwords or "Send As" alias setup.

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:

• Settings > Passwords > AutoFill Passwords — turn off
• Settings > General > AutoFill — turn off Contact Info and Credit Cards

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 Guide → Step 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:

• yourbooking.au on port 443 (HTTPS/WSS)

Changing Configuration

To change the Optomate API credentials or other settings:

1. Edit the .env file in the install directory (e.g. C:\Program Files\YourBookingAgent\.env)
2. Restart the service using one of:
   • Windows Services: open services.msc, find "Your Booking Agent", 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\logs\winsw.err.log"

Log files rotate automatically at 5MB.

Service Management

The agent runs as a Windows service called YourBookingAgent. 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).

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.

Troubleshooting

Agent won't start

• Check logs: type "C:\Program Files\YourBookingAgent\logs\winsw.err.log"
• Verify the .env file has all required values
• Check the Windows service status in services.msc

"Optomate authentication failed"

• Verify the username and password in .env match what you configured in Optomate's API Access settings
• Ensure the API access list has the required permissions (Step 1.2)

"Cannot reach Optomate"

• Check Optomate Touch is running
• Verify the API URL: open http://localhost:12000/OptomateTouch/OData4/Branches in a browser on the server
• If Optomate is on a different machine, use that machine's IP in the API URL

Booking page shows "agent offline"

• Check the service is running: winsw status (from install directory) or check Windows Services
• Check the logs for connection errors
• Verify internet connectivity from the server

Booking shows "temporarily unavailable"

• The agent is not connected. Check the service is running and review the logs.
• If the agent connects but disconnects quickly, check that no other agent is using the same licence key.