Sync Settings¶
Autotask Mirror syncs 200+ entity types from the Autotask API on configurable schedules. Each entity can be individually configured with its own sync interval, schedule, and sync mode.
Default Schedules¶
On first launch, all entities are seeded with default sync schedules organized by tier:
| Tier | Interval | Entities |
|---|---|---|
| Core (30 min) | Every 30 minutes | Tickets, TicketNotes, Companies, CompanyNotes, CompanyToDos, Contacts, TimeEntries, ServiceCalls, Projects, Tasks, TaskNotes |
| Important (1-2 hours) | Every 60-120 minutes | Contracts, Opportunities, Phases, ConfigurationItems, ConfigurationItemNotes |
| Incremental (8 hours) | Every 8 hours | Entities that support incremental sync via last-modified tracking |
| Full Sync (24 hours) | Daily | Entities that require a full table refresh each sync |
Start times are automatically staggered across entities to prevent all syncs from running simultaneously.
Configuring an Entity¶
From the Dashboard, click the edit icon on any entity row to open the sync settings dialog.
Sync Interval¶
Set how frequently the entity syncs. Choose a numeric value and unit:
- Minutes — For high-priority entities that change frequently (e.g., Tickets)
- Hours — For moderately active entities (e.g., Contracts)
- Days — For slowly changing reference data (e.g., Roles, Departments)
Start Time¶
Set the time of day when the sync should run. This is combined with the interval to build the full schedule. For example, an interval of 24 hours with a start time of 2:00 AM runs a daily sync at 2:00 AM.
Start Day¶
For weekly schedules (interval of 7+ days), select the day of the week when the sync should run.
Sync Mode¶
Entities support one of two sync modes:
- Incremental — Only fetches records modified since the last sync. Uses a tracking field (typically
lastActivityDate) to query for changes. This is more efficient and recommended for large entities. - Full — Fetches all records every sync. Required for entities that don't support date-based filtering.
The sync mode is determined by the entity type and cannot be changed manually.
Clean Table Before Sync¶
When enabled, the target SQL table is truncated before each sync. This ensures a clean copy of the data but means records deleted in Autotask are also removed from the mirror.
Note
Clean Table is only applicable to Full sync mode entities. Incremental entities accumulate records over time.
Enabled¶
Toggle whether the entity syncs at all. Disabled entities are removed from the job schedule and do not appear in the running job count.
Schedule Preview¶
The settings dialog shows a human-readable preview of the resulting schedule. Examples:
- "Every 30 minutes"
- "Every 4 hours"
- "Daily at 2:00 AM"
- "Every 2 days at 11:30 PM"
- "Weekly on Monday at 9:00 AM"
Triggering a Manual Sync¶
From the Dashboard, click the sync icon on any entity row to trigger an immediate sync. This runs the entity's sync job once, outside of the normal schedule.
Resetting Sync Settings¶
Click Reset on an individual entity to restore its default sync schedule. Use the Reset All button to restore defaults for all entities.
Module Toggles¶
Some entity groups are disabled by default and can be enabled from the Preferences page (/settings/preferences):
Multi-Currency Module¶
Enables syncing of price list entities:
- PriceListMaterialCodes, PriceListProducts, PriceListProductTiers, PriceListRoles, PriceListServiceBundles, PriceListServices, PriceListWorkTypeModifiers
Only enable this if your Autotask instance uses multi-currency features.
Document Module¶
Enables syncing of document-related entities:
- Documents, DocumentAttachments, DocumentNotes, DocumentCategories, DocumentChecklistItems, DocumentPlainTextContent, DocumentTagAssociations, DocumentTicketAssociations, and more
Enable this if you need Autotask document data in your reports.
Info
Toggling a module on enables all entities in that group with their default schedules. Toggling it off disables all entities in the group and removes their scheduled jobs.