This site is only for Avalara customers licensed for Returns Excise, AvaTax Excise and Government.
Documentation of operation, usage and release dates is confidential and proprietary information of Avalara.
This document applies to Enterprise customers. Content last updated 2021-03-25.
Data Replication Service (DRS) replicates key data tables from the Avalara Returns Excise SaaS environment to an on-premise database to enable local reporting and analytics. Additional Avalara licensing is required.
- User initiates sync of Master Data and Tax Sessions on demand or on a configurable schedule.
- Replication data is written to an on-premise database owned by the customer.
- Avalara product updates provide schema changes to keep the replication data identical to the ARE SaaS tables.
- Custom reporting can be done on the DRS database.
- Secure protocols to specific URLs are configured by the customer's IT department.
Types of Data Synchronized
Sync is a complete overwrite of previous data.
- Tables with Tax Session-related data.
- Examples: Schedule Transactions, Header Sequences, and Business Entity/Accounts
- Master Data - not necessarily associated with a Tax Session.
- Examples: Business Entity/Accounts, Locations
NOTE: Master Data Export/Import can be used to copy specific tables between Production and Sandbox without affecting the Sync data.
Setting up Replication
An Administrative login is required.
- Click Maintenance > Replication Service
- There are 5 tabs to configure and monitor DRS
Displays pending and completed items
- The dropdown filter displays Pending (default), All Items or Completed Items
- Replicated Tax Session information displays in the Key column
- Change the order of the Queue using the Up or Down arrows on the task's grid line
- Cancel a job by clicking the red X
- Click Add New Record to initiate an immediate one-time Replication Service Event, using the check boxes and dropdowns to select preferences
Schedule, view and maintain replication events.
- Click Add New Record.
- Populate the Replication Service Event, then click Insert. The asterisk * indicates required information
- The options you see will depend on the Replication Object Type selected
- When replicating Tax Session, if the Include Supporting Data box is checked, then the Business Entity/Accounts, Locations, Products, Companies, Company Accounts and Company Information will also be replicated. Only check this box if changes have been made since the last Sync, to streamline the replication.
Customize the default values, shown below.
Check the health of the Replication Service.
- Green checkmark - Service is active and running.
- Red X - Service is not running.
- Critical stop - the last Heartbeat was missed.
- After 3 missed Heartbeats, the status will change to a red X
View status and download the file from Export as Scheduled Task via Excel or CSV run from any of the tabs.
Understanding how DRS works will help you trace event errors or Heartbeat issues.
- DRS makes data requests to Avalara SaaS using API.
- DRS receives data to be replicated from the API call.
- Data is received in chunks and loads them into the on-premise replication database.
- Success/Failure message is returned with a timestamp.
When a Replication Event fails
- Is the Settings tab set to the specific company you want to replicate?
- Is the Calendar tab set to valid dates and the specific company you want to replicate?
- Are there pending or active jobs in the Queue tab? If not check:
- the Heartbeat tab
- if any changes been made to the Avalara Excise\Replication appsettings.config file in the install
- if there were network interruptions during the schedule replication time
- if SaaS has had a schema change in the quarterly release
- If so, you may need to take the corresponding DRS upgrade to current version
When the heartbeat fails
- that the Avalara Excise Replication is in a Running status in the "services" interface on the server hosting the DRS database
- the application.log file from the Avalara\Excise Replication folder for errors
- the log file from your Replication database for errors
Test the API access
- Launch the Avalara_Excise_Replication Installer
- Click Configure on the Welcome screen
- Click the Settings Configuration tab
- Click Validate Access - you will get either Valid Access or Unable to Validate with an error code
- Close the Installer
SQL Replication database views
You can use Views > Schedule_information, which combines data from: