Skip to main content

What database integration methods does Aiwyn support?

Christa Mason
Updated

This article helps you understand how Aiwyn securely integrates with your practice management database and what access options are available so you can choose the approach that best fits your environment.

Database-Level Integration Overview

You can enable reliable, incremental data synchronization between your database and Aiwyn.

Due to the lack of comprehensive APIs across many practice management systems, Aiwyn integrates directly at the database level using methodologies such as Change Data Capture (CDC), Change Tracking, or High-Water Mark (HWM) processing. This approach allows Aiwyn to capture only incremental changes and deliver a consistent, high-quality application experience.

There are two options for how that access is provided:

  • Whitelist Aiwyn’s Static IP Address + SQL Server Encryption
  • SSH Tunnel

All integration methods require a read-only SQL authentication-based user .

Whitelisting Aiwyn’s Static IP With SQL Server Encryption

You can provide secure, direct database access using TLS encryption and IP whitelisting.

This is the most straightforward integration option when your SQL Server supports encrypted connections.

  1. Ensure SQL Server Encryption is enabled so all in-transit data is protected using TLS.

  2. Create a SQL user and assign it to the db_datareader role.

  3. Whitelist Aiwyn’s static IP address on your network or firewall.

  4. Provide Aiwyn with the required database access information.

  • If the SQL Server resides in a .local network domain, TLS certificate-based encryption cannot be used.

  • Local Windows accounts cannot be used for SQL authentication in this scenario.

Click Here for Instructions

SSH Tunneling To The SQL Server

You can secure database access through an encrypted tunnel when TLS is not available.

This method is preferred when a TLS certificate cannot be installed on SQL Server.

  1. Create an aiwyn user on the SSH server.

  2. Create a public and private SSH key pair if key-based authentication is preferred.

  3. Configure the SSH server to allow access to the on-premise SQL Server.

  4. Install the public SSH key on the SSH server if using key-based authentication.

  5. Validate name resolution and restrict inbound traffic to the SSH port (typically 22).

  6. Provide Aiwyn with the SSH host, SSH port, SSH user, SSH password (if applicable), and private key file (if applicable).

  7. Create a SQL user and assign it to the db_datareader role.

  8. Whitelist Aiwyn’s static IP address.

  9. Provide Aiwyn with the required database access information.

    Click Here for Instructions

Both integration options ensure secure, read-only access while allowing Aiwyn to reliably process incremental database changes.

Related articles