This page lists every IT task your firm completes to implement Aiwyn Payments, in the order most firms work through them, with a link to the guide for each one. It is written for your firm's IT lead or third-party IT service provider.
Not every task applies to every firm. Single sign-on and email delivery apply to everyone. The database tasks apply only when Aiwyn connects to your practice management database. The mail rule and the system-specific tasks depend on which practice management system you use.
Technical questions are welcome at any point. Email implementation@aiwyn.ai so your question is visible to the whole Aiwyn Implementation team and gets a prompt answer.
Before you start
Aiwyn gives you three things during implementation. Have them on hand before you begin.
| What | Where it comes from | Used for |
|---|---|---|
| IT Checklist in Clickup | Provided by Aiwyn at start of Implementation. | Returning values and credentials to Aiwyn securely, such as your SSO application and tenant IDs. |
| DKIM and return path values | -Your Implementation Tracker under Important Links. -Provided to you via email at start of Implementation. |
DNS records (task 4). |
| Aiwyn inbound email address and subject line text | -Your Implementation Tracker under Important Links. -Your Implementation Specialist, before the first Testing Session call. |
The invoice mail rule (task 10). (Excludes firms using CCH Axcess) |
Tasks for every firm
Every firm completes these five tasks, whichever practice management system it uses.
Single sign-on
Access to the Aiwyn Firm Portal is provided only through single sign-on (SSO), so an active SSO environment is required.
| # | Task | What you do | Guide |
|---|---|---|---|
| 1 | Add Aiwyn to your SSO environment | Register Aiwyn as an application with your identity provider and return the IDs it generates to Aiwyn through your IT Checklist | Add Aiwyn to my SSO environment, then the guide for your provider: Azure, Okta, Duo, ADFS, Google Workspace |
| 2 | Enable the Aiwyn application for firm staff | Assign the Aiwyn application to the staff who need the Firm Portal, one user at a time or through an SSO user group | The access section of your identity provider's guide in task 1 |
| 3 | Create an SSO guest user for Aiwyn Support | Create a dedicated user in your SSO directory, with first name, last name and email address populated, and share its credentials securely so Aiwyn Support can troubleshoot in your Firm Portal | Create an SSO guest user for the Aiwyn Firm Portal |
Email delivery
Aiwyn sends invoice and payment emails on your firm's behalf. These two tasks authenticate that mail and keep it out of spam filters.
| # | Task | What you do | Guide |
|---|---|---|---|
| 4 | Add DKIM and return path DNS records | Add the DKIM (TXT) and return path (CNAME) records for each domain Aiwyn sends from. If you use DMARC, add Aiwyn's SPF value as well | Add DKIM, return path, and DMARC DNS records for Aiwyn |
| 5 | Whitelist Aiwyn's email sender IP ranges | Add Aiwyn's sender IP ranges and the aiwyn.ai domain to your mail allowlist. Firms on Mimecast with anti-spoofing enabled also add a bypass policy | Whitelist Aiwyn email sender IP ranges and bypass anti-spoofing |
Database connection
Complete tasks 6 to 9 if Aiwyn connects to your practice management system through its SQL Server database. The connection is read-only in every case, and your SQL Server must be able to negotiate TLS 1.2.
Skip this section if your system connects by API (iFirm, PracticeERP, Karbon or QuickBooks Online). PracticeEngine Cloud firms follow the PracticeEngine guide under Additional tasks instead. For the background, see How Aiwyn connects to your practice management database.
| # | Task | What you do | Guide |
|---|---|---|---|
| 6 | Choose your database integration method | Pick IP whitelisting or an SSH tunnel, using the table below | How Aiwyn connects to your practice management database |
| 7 | Verify your SQL Server port | Confirm in SQL Server Configuration Manager which TCP port your instance listens on. The default is 1433 | Find the TCP port your SQL Server listens on |
| 8 | Create a read-only SQL login | Create a dedicated login that uses SQL Server authentication and assign it to the db_datareader role | Create a read-only SQL login for Aiwyn |
| 9 | Open the connection to Aiwyn | Complete the guide for the method you chose in task 6 | See the table below |
Which integration method to use
Your environment usually decides. Both methods need the read-only SQL login from task 8.
| Method | Use it when | What you do | Guide |
|---|---|---|---|
| IP whitelisting with SQL Server encryption | Your SQL Server can accept encrypted connections and holds a TLS certificate | Enable TLS encryption on SQL Server, then allow 35.245.176.176 to reach your SQL Server port through Windows Firewall and your network firewall | Whitelist Aiwyn's static IP and use SQL Server encryption |
| SSH tunnel | A TLS certificate cannot be installed on the SQL Server, including any SQL Server in a .local network domain | Set up an SSH server in your environment that forwards Aiwyn's connection to SQL Server | Configure SSH tunneling in a Windows Server environment |
Invoice mail rule
Complete task 10 if your firm emails invoices from its practice management system through its own mail server, on Microsoft 365 or Google Workspace. CCH Axcess firms do not use a mail rule.
| # | Task | What you do | Guide |
|---|---|---|---|
| 10 | Create the Aiwyn mail rule | Create a rule that redirects outgoing invoice emails matching your subject line text to your firm's Aiwyn inbound email address | Create a mail rule to route invoice emails to Aiwyn |
Do not enable this rule on your own. Create it live during your first Testing Session with your Aiwyn Implementation Specialist on the call. If you build it ahead of time, leave it disabled until that session.
Before the session, confirm two things:
- Invoice emails from your practice management system pass through your own mail server, not the vendor's SMTP service.
- Filtering services in your outbound mail path, such as Mimecast or Proofpoint, will not intercept these messages before the Aiwyn rule runs.
Additional tasks by practice management system
Some systems need a few more tasks on top of the ones above. Find the system you are connecting to Aiwyn. If it is not listed, no additional tasks are required.
| System | Additional tasks | Guide |
|---|---|---|
| CCH Axcess | Schedule the DAU update and the full refresh in Task Scheduler at the prescribed times. The full refresh runs five minutes before each DAU update. No mail rule is needed | CCH Axcess DAU update and full-refresh schedule and Why Aiwyn requires a daily full refresh of CCH Axcess DAU tables |
| PracticeCS | To be confirmed. See open questions | |
| PracticeEngine Cloud | Create an Azure AD user for the database connection and ask IRIS to grant it access and allow 35.245.176.176. Then route PracticeEngine's outgoing email through your firm's mail servers: request its outbound IP addresses, remove legacy SMTP servers, add an Exchange connector, update your SPF record and set the SMTP server in PracticeEngine | Configure PracticeEngine (cloud) to connect and send invoices through Aiwyn |
| Star | If your firm wants Aiwyn payment files imported into Star automatically, ask Star to configure the Receipts Batch Import tool and build the automation that sweeps Aiwyn's CSV files into it | Import payments with the Star cash receipts tool |
| QuickBooks Online | To be confirmed. See open questions |