Initial Setup¶
After deploying Autotask Mirror, follow these steps to get data flowing.
Installation¶
No installation steps are needed — the Azure Marketplace deployment provisions and configures everything automatically. Skip to First Launch below.
- Download the latest Enterprise release package and extract it to a temporary directory
-
Run the install script as an administrator:
On Windows (PowerShell as Administrator):
On Linux (as root):
The install script will:
- Extract the application to the default install directory
- Generate a self-signed TLS certificate
- Register two Windows Services (or systemd units on Linux): the main application and the updater service
- Configure internal authentication between the services
Default install locations:
Platform Path Windows C:\Program Files\FidelisAutotaskMirrorLinux /opt/fidelis-autotaskmirror -
Configure the database connection string — Edit
appsettings.jsonin the install directory and setConnectionStrings:AutotaskMirror:Using SQL Authentication:
{ "ConnectionStrings": { "AutotaskMirror": "Server=YOUR_SERVER;Database=AutotaskMirror;User Id=YOUR_USER;Password=YOUR_PASSWORD;TrustServerCertificate=True" } }Using Windows Authentication:
{ "ConnectionStrings": { "AutotaskMirror": "Server=YOUR_SERVER;Database=AutotaskMirror;Integrated Security=True;TrustServerCertificate=True" } }Tip
If using Windows Authentication, update the service Log On account so the Windows Service runs as a user with SQL access: services.msc > FidelisAutotaskMirror > Properties > Log On.
-
Create the database — Create an empty database named
AutotaskMirror(or your preferred name) on your SQL Server. All schema migrations are applied automatically on first start. -
Start the services:
On Windows (PowerShell):
On Linux:
Note
The first start may take several minutes while database migrations are applied.
-
Open the dashboard — Navigate to
https://localhost:5001in your browser -
Enter your license key — Go to Settings > License and enter the license key provided with your Enterprise purchase
First Launch¶
When the application starts for the first time, it automatically:
- Creates and applies all database migrations
- Seeds default sync schedules for all Autotask entity types
- Starts the background job engine
During startup, the application returns 503 Service Unavailable with a Retry-After header until initialization is complete. This is normal — the dashboard will load once startup finishes.
Step 1: Configure Autotask API Credentials¶
Navigate to API Settings in the left sidebar (or go to /settings/autotask).
- Enter your API Username (the email address of your Autotask API user)
- Click Detect Zone — the application will automatically determine your Autotask API zone
- Enter your Integration Code
- Enter your API Password
- Click Save
API credentials are hot-reloaded — changes take effect within 60 seconds without restarting the application.
For more details, see Autotask API Configuration.
Step 2: Verify Sync is Running¶
Return to the Dashboard (home page). You should see entities beginning to sync:
- The Running Now card shows how many entities are currently syncing
- Individual entity rows show status, record counts, and duration
- The status column updates automatically every few seconds
Note
The first full sync of all entities may take several hours depending on the size of your Autotask instance and the number of enabled entities.
Step 3: Enable Authentication (Recommended)¶
By default, Autotask Mirror runs without authentication. A warning banner at the top of the page will remind you to configure it.
Navigate to Authentication for setup instructions for your identity provider.
Step 4: Connect Power BI¶
Once data is flowing, connect Power BI Desktop to your SQL Server database:
- Open Power BI Desktop
- Select Get Data > SQL Server
- Enter your SQL Server hostname and database name
- Choose your authentication method (Windows, SQL, or Azure AD)
- Select the tables you need — foreign key relationships are automatically detected by Power BI
Tip
Start with the core tables: Companies, Contacts, Tickets, TimeEntries, and Projects. These cover the most common reporting scenarios.