Aiwyn reads your practice management data by connecting directly to its database. This page explains why, and what that means for your IT team.
Why the database and not an API
Most practice management systems do not expose a comprehensive API, so a database-level connection is the only way to get complete, current data. iFirm, PracticeERP, Karbon, and QuickBooks Online are the exceptions and are supported via API.
For database connections, Aiwyn reads incremental changes using change data capture, change tracking, or high-water mark processing. There is no single method assigned to each practice management system; the method can vary for a given system. The database connection is read-only in every case.
Supported SQL Server and TLS versions
Aiwyn does not exclude any SQL Server version by version number. However, the SQL Server instance must be able to negotiate TLS 1.2 to be supported.
Two ways to grant access
There are two supported routes, and your environment usually decides which.
IP whitelisting with SQL Server encryption. Aiwyn's ETL service connects to your SQL Server across the internet from a fixed IP address, over TLS. This is the more straightforward route when your SQL Server can accept encrypted connections and holds a TLS certificate.
SSH tunnel. Aiwyn connects to an SSH server in your environment, which forwards the connection to your SQL Server. This is the route to take when a TLS certificate cannot be installed on the SQL Server.
When IP whitelisting is not available to you
If your SQL Server sits in a .local network domain, certificate-based TLS cannot be used, and local Windows accounts cannot be used for SQL authentication in that configuration. In that case use the SSH tunnel.
What both routes have in common
Both require a dedicated read-only SQL login using SQL Server authentication, assigned to the db_datareader role, and both give Aiwyn read-only access. See Aiwyn database connection requirements for the addresses, ports and settings.
Related
- Aiwyn database connection requirements
- Whitelist Aiwyn's ETL service to reach your SQL Server
- Set up SSH tunneling for Aiwyn on Windows Server
- Create a read-only SQL login for Aiwyn