Getting started
This page takes an administrator through the first setup of SQL Connector, from the connection to the external server until the first data has arrived. Each step links to the page that describes it in detail.
Overview
This must be in place before you start:
- An external data store, for example Azure SQL, and the server, database and credentials (username and password, or a connection string).
- The URL and app key of the Azure Function that sends the commands to the data store.
- The user has the "SQL Connector Synchronization Administrator" role if they should see the dashboard and the menu.
How it works
The assisted setup takes you through most of the steps below. You can quit at any time, because the data is saved as you go.
- Set up the server connection. Open Assisted Setup or Server Setup and fill in the server, database, Azure Function URL and app key, or a connection string. Check: Test Connection shows green.
- Choose tables. Open the table setup and add the Business Central tables to synchronize. See Table Setup. Check: The table has a server code and fields in the field list. See Field Setup.
- Choose Create Table to add the create-table command to the processing log, then turn on Enable. Check: Table Structure Created is marked when the command is queued; this does not confirm delivery to the external database. After the command is sent, check the processing log and confirm its status is Completed.
- Create a job queue. Step 4 of the assisted setup or the Automation page creates a job queue entry on hold. Choose Set Ready so it starts running. Check: The job queue entry has the status Ready.
- Read the summary in the last step of the assisted setup. ❌ means something is missing.
After the first run, the dashboard and the processing log show whether the entries have the status Completed.
Benefits
When you set it up in this order, the connection is tested before any data is sent, and the create-table command is queued before synchronization starts.