---
title: "dsCONNECT User Guide v2.0.1"
canonical: "https://servicedesk.maxgeo.com/space/mxAPI/2419425281/dsCONNECT%20User%20Guide%20v2.0.1"
format: markdown
---
> Macro (toc)

*This guide shows how dsConnect lets licensed users pull MDS data into a local SQL Express database, customize and group data layouts/tables, and automate regular refreshes. It explains creating/editing layouts and tables (including handling geometry fields), testing connections, exporting/importing configurations, and exporting data to Excel/CSV/Access. Follow it to set up reliable, repeatable local copies of MDS data and streamline team configurations.*



The **dsConnect** application allows licensed users to download data directly from the datashed **MDS** and save it locally in a **SQL Express** database on their own workstation.

![dsCONNECT User Guide - Step 0 (1).jpeg](media://a86ad7c9-3f06-4fa9-8615-5fd206cdb3fd)



# System Requirements

> ⚠️ - [mxAPI Licensing and User Requirements](https://servicedesk.maxgeo.com/space/mxAPI/1797455873/mxAPI+Licensing+and+User+Requirements)
> ⚠️ - DataShed5 version 3.2 or newer
> ⚠️ - mxAPI v1.5.4.0 or later
> ⚠️ - Application installed as per [installation guide](https://servicedesk.maxgeo.com/space/mxAPI/1784348754/dsCONNECT+Installation+Guide+v1.0)

> ⚠️ Each client has a **unique API URL**. To use dsCONNECT, users must enter their organisation’s specific API endpoint.
> ⚠️ 
> ⚠️ For maxgeo Cloud clients, the API URL format is:
> ⚠️ 
> ⚠️ ```
> ⚠️ https://companynamemxapi.maxgeo.com/api/v2/
> ⚠️ ```
> ⚠️ 
> ⚠️ If you are unsure of your correct API URL, please contact the [maxgeo Service Desk](https://maxgeo.atlassian.net/servicedesk/customer/topic/2514cec8-77bc-4396-822b-b8461006535b) for assistance.

> ℹ️ [Download the dsConnect installer here.](https://s3.ap-southeast-2.amazonaws.com/updates.maxgeo.com/software/dsCONNECT/v1.0.2.0/dsCONNECTInstaller_v_1.0.2.exe)

> ❌ **Note:** ODBC Driver 18.7.1.1 has an issue and does not work with dsCONNECT. Latest recommended version is 18.6.2.1

# Application Information

Click the **?** button to open the MDS Version Information dialogue

![dsCONNECT User Guide - Step 2 (1).jpeg](media://825775ce-baa7-4172-b85f-c652471e30b2)





# The dialogue displays:

1. MDS Version
2. Available Layouts
3. Total Destination Tables
4. Application Version
5. API Version

![dsCONNECT User Guide - Step 3 (1).jpeg](media://4eb35dc4-d5c8-4f4c-9474-75e8f0b62fad)



Click **OK** to close the dialogue.

![dsCONNECT User Guide - Step 4 (1).jpeg](media://2cba00b6-74d0-40de-ae05-3f82381f067c)





# Layouts

The default installation comes with three Layouts

1. **ArcGIS** - 5 tables
2. **IOGAS** - 5 tables
3. **LeapFrog** - 14 tables

Switching between Layouts is done by clicking the Layout dropdown list and selecting the desired Layout.

![dsCONNECT User Guide - Step 6 (1).jpeg](media://fcfd6874-3bf1-461c-b79c-03166ad25317)



## Edit an Existing Layout

Select the Layout to work with, then click the **Edit** button.

![dsCONNECT User Guide - Step 8 (1).jpeg](media://450bb3a6-922d-4812-aefc-d5f3c09d53b7)






In the Edit Layout dialogue, the following items can be edited:

1. Layout Name
2. Description
3. MDS Version (This can be maintained by the Test Connection feature)

![dsCONNECT User Guide - Step 9 (1).jpeg](media://86c610ad-4a16-4cc9-a61c-14a8a126c126)




## Creating a New Layout and Adding a Custom Table

Click the **+** button

![dsCONNECT User Guide - Step 11 (1).jpeg](media://eee956f4-e093-42c5-acdc-5b908db5a157)





The "**Create New Layout**" dialogue opens.

Enter a **Layout Name** and **Description**, then click "**OK**" to create the Layout.

![dsCONNECT User Guide - Step 12 (1).jpeg](media://f69318d9-9847-4870-bb09-9751bd80f21f)



A success message is displayed, click **OK** to close this message box.

![dsCONNECT User Guide - Step 13 (1).jpeg](media://0c827041-7873-418f-9164-2ea6fe13aa40)




Click the **Add Table** button

![dsCONNECT User Guide - Step 14 (1).jpeg](media://c876c9e3-ca85-4534-982b-4a6e0e0d420f)





The **Create New Destination** **Table** dialogue will open.

![dsCONNECT User Guide - Step 15 (1).jpeg](media://54422d19-c9d0-463a-ba12-ef35bbc7aa1f)


This window can be resized.

Enter the following fields:

1. Dispaly Name - The name displayed in dsConnect
2. Table Name - The name used in the table in SQL Express (see Tip below)
3. Description - A meaningful description of the table
4. SQL Query - The SQL statement that will select the required data.
5. Order By - The filed list that uniquely identifies a record.

Click "**OK**" to save the table.

![dsCONNECT User Guide - Step 16 (2).jpeg](media://e33b3ac7-2585-4ac9-9aea-b266933854f8)


Click **OK** to continue.

![dsCONNECT User Guide - Step 17 (1).jpeg](media://68ddb25e-25f7-4302-aded-a6e1d780f2e1)


> ✅ **Tip!** It is recommended to name the table with the Layout name and "_" then a table name. This will keep all Layout tables grouped together in SQL Express.

> ✅ **Tip!** To limit data to a specific **DataSet**, include a **where DataSet='xxx'** in the SQL query.

> ⚠️ SQL statements in dsConnect are **case sensitive**. Please ensure to use the same case for **table and** **field names** as they appear in the MDS.

> 📝 **Note:** All SQL Select statements must contain the fields **DataSet **and** Load_Date**. dsConnect will only download SQL statements that contain the **DataSet **and** Load_Date** fields. This is how dsConnect limits your data download to data belonging to the **DataSets** you have been granted access to, and can refresh tables in paginated chunks.
> 📝 
> 📝 If the **DataSet **and** Load_Date** fields are not included in the SQL query, the below (or similar) warning will be displayed.

![DataSet error.jpg](media://e9fac3ca-9121-45b5-8e0d-ad8cbecc0253)


![dsCONNECT User Guide - Step 17.jpeg](media://c25929b1-7dd4-49fc-b744-83ff741a91de)



> 📝 **Note:** If your SQL Select contains a field of type “geometry”, you will need to cast the field to a different data type. This may be common when using a **MDS v5.0.0** database or above.
> 📝 
> 📝 ie. CAST([Preferred_Geometry] AS NVARCHAR(MAX)) as Preferred_Geometry
> 📝 
> 📝 **Example:** SELECT [Lease_ID]
> 📝 
> 📝                       ,[AuthorityCode]
> 📝 
> 📝                       ,**CAST([Preferred_Geometry] AS NVARCHAR(MAX)) as Preferred_Geometry**
> 📝 
> 📝                       ,[ObjectID]
> 📝 
> 📝                  FROM [tblVWDHCoordinates]

> 📝 **Note:** If your query contains a field type unrecognised by dsConnect, and the table name is the same as the Query table name, you will be prompted to Cast the field to Text. Click "Yes" to proceed with this, or "No" to manually enter a Cast statement.

![dsCONNECT User Guide - Step 20.jpeg](media://7f2858e6-8ca6-434d-b1e6-52ddffda2275)


The changes will be displayed in a popup. Click **OK** to proceed.

![dsCONNECT User Guide - Step 21.jpeg](media://d0996002-1531-4847-87d7-c4b7627ec7ce)



Click **OK** at the popup indicating the fields that were Cast to Text.

![DSConnect User Guide - Step 22.png](media://1fa68c92-bcf1-466c-98e4-10eafa3f466a)

Here is the automatically Cast Field.

![dsCONNECT User Guide - Step 22 (1).jpeg](media://65d13f5f-8fad-42d0-8ba3-9255b87613fb)





After completing the above details, click **OK** to save the table definition.

![mxConnect User Guide - Step 19 (1).png](media://dcc5192f-c8a1-4201-a87f-d6cbba032a17)



A success message will be displayed. Click **OK** to close this message.

![mxConnect User Guide - Step 20 (1).png](media://0437feeb-ae5b-442e-99d0-fc8a16fe09e9)



The new table will be displayed in the Destination Tables for the new Layout.

![dsCONNECT User Guide - Step 23 (1).jpeg](media://16ca7e27-93c1-46de-91a9-e58c7b1589c4)





# Loading Data to Tables

To load data or refresh data in a Table, select the table then click the **Update Selected Table** button.

![dsCONNECT User Guide - Step 25.jpeg](media://9d51c71b-e61a-41ad-82e7-29be99e21a78)





The **Status** panel at the screen bottom will display the progress. When the Table data has been updated, a success message will display.

![dsCONNECT User Guide - Step 26 (1).jpeg](media://5740ac65-3f9d-42e6-93ce-0951d6a50380)





Click **OK** to close the message box.

![dsCONNECT User Guide - Step 27 (1).jpeg](media://de8becba-05fd-47bf-84ad-1ccaa1a75361)




## Update All Tables in a Layout

Click the **Update Selected Layout** button. This will refresh data in all the tables in the selected Layout.

![dsCONNECT User Guide - Step 29.jpeg](media://83a6dcf6-4f5b-4966-be04-5d09ede4a4a3)





Click **Yes** on the **Refresh Layout Table** dialogue

![dsCONNECT User Guide - Step 30 (1).jpeg](media://ce4f6434-0909-4398-8f31-dd50219614b9)



The Status panel will show the update progress.

![dsCONNECT User Guide - Step 31 (1).jpeg](media://6dd32d80-f494-4773-a7e0-13c29cd5e623)




Click **OK** on the success message box

![dsCONNECT User Guide - Step 32 (1).jpeg](media://8a49f073-f2b1-4805-a9fd-bd0d8ba87381)



Then the below will show any tables that failed to update.

![dsCONNECT User Guide - Step 33 (1).jpeg](media://6e0beadd-000c-46e2-8ab4-7a08b2ca4845)



## Update Data in All Tables in All Layouts

Click the **Update all Tables** button and follow the message boxes as above. This will refresh data in all tables in all Layouts.

![dsCONNECT User Guide - Step 35.jpeg](media://3c424648-5289-402e-9391-6b332600ab58)




# Delete a Layout

Click the **Delete** button

![dsCONNECT User Guide - Step 37.jpeg](media://27f24c0b-8b6f-45be-a8d4-4255ba1b3fb1)




A warning message box will display "**Are you sure you want to delete the layout 'Test'?**

This will also delete 1 associated destination table(s) and their configurations."

![dsCONNECT User Guide - Step 38 (1).jpeg](media://d14faf08-53f5-4abe-b43e-756895c9d6a7)




Click **Delete Layout** to delete the Layout

![dsCONNECT User Guide - Step 39 (1).jpeg](media://47143223-b2ed-42be-a31b-c8a6cf92cd7a)




A success message box will be displayed. Click **OK** to close this message box.

![dsCONNECT User Guide - Step 40 (1).jpeg](media://f3e9fd10-84d4-4912-81ae-ee8abb723be9)




# Schedule Automatic Data Table Refresh

Select the **Frequency Type** for the Refresh

![dsCONNECT User Guide - Step 42.jpeg](media://75c43f00-dd25-4852-8d40-e5ed85d3d3e1)


Click the **Clock** icon to open the **Time Chooser**.

![dsCONNECT User Guide - Step 43 (1).jpeg](media://f1380c0d-432d-4a18-859b-0380425ed98f)


Select the desired **Hour**.

![dsCONNECT User Guide - Step 44 (1).jpeg](media://31e4ea7e-6670-46e1-be64-ee83ab333462)


Click **Minute** to choose the desired Minute.

![dsCONNECT User Guide - Step 45 (2).jpeg](media://4c09e684-a68c-409b-9326-f5a0eaa8c9df)


And select the minute setting.

![dsCONNECT User Guide - Step 46 (1).jpeg](media://9c52a919-0b57-4636-85c4-24f7483ef1ac)


Choose **AM** or **PM.**

![dsCONNECT User Guide - Step 47 (1).jpeg](media://43db7ddd-62fd-45b1-a036-b8f1e5c9626e)


Click **OK** to set the Schedule.

![dsCONNECT User Guide - Step 48 (1).jpeg](media://7904baca-7331-41ea-904e-a1551c4ee575)


Click the **Enable Schedule** Check Box to make the Schedule **active**.

![dsCONNECT User Guide - Step 49 (2).jpeg](media://464bf2f4-438c-4a44-b110-38054c52125a)


Click "**Yes**" to confirm the Schedule.

![dsCONNECT User Guide - Step 50.jpeg](media://d355db9c-0458-4c12-ad39-00245b89d623)


The Status panel will show the Schedule activation progress.

![dsCONNECT User Guide - Step 51 (1).jpeg](media://29b5e766-6194-407d-9cf2-77633795df14)



## Disable a Scheduled Refresh

Untick the "**Enable Schedule**" check box.

![dsCONNECT User Guide - Step 53.jpeg](media://04153f74-0a13-49f4-876e-b0d2ad208663)


# Refresh Frequency Options

Refresh **Once** - Refresh tables at the set time as a once off only.

![dsCONNECT User Guide - Step 55.jpeg](media://2a612f50-2b34-4a5c-9085-cad743ffdcae)

Set the time for the table refresh then click the **Enable Shedule** checkbox.

![dsCONNECT User Guide - Step 56.jpeg](media://d43b9d13-803f-4527-9ccf-ac32a77a909e)

Refresh **Hourly** - Refresh tables to refresh at the scheduled frequency.

![dsCONNECT User Guide - Step 57 (1).jpeg](media://b6389201-b853-41f4-89f1-b3145e2dd567)

Set the Start Time, End Time, Hourly Frequency (1 hourly, 2 hourly, etc), select the Days the Schedule will run.

![dsCONNECT User Guide - Step 58.jpeg](media://2206a883-1d4a-41e8-8181-1f0dce4dbf39)

Refresh **Daily** - Refresh tables to refresh at the scheduled frequency.

![dsCONNECT User Guide - Step 59.jpeg](media://7a13dd11-b2cd-4135-8b51-efccef4b3a00)

Select the Shedule Refresh Time.

![dsCONNECT User Guide - Step 60.jpeg](media://9a378ea8-25b6-485e-9e26-4832dd01cb0b)

Refresh **Weekly** - Refresh tables to refresh at the scheduled frequency.

![dsCONNECT User Guide - Step 61.jpeg](media://1f7b108b-b0ae-46af-9308-5072a8b66c5a)

Set the **Schedule Refresh Time** and to Day to refresh.

![dsCONNECT User Guide - Step 62.jpeg](media://82d0b088-b0c9-47c5-b19b-501293b1a093)

Refresh **Monthly** - Refresh tables to refresh at the scheduled frequency.

![dsCONNECT User Guide - Step 63.jpeg](media://007e21e5-a09d-4b3e-932c-2cf6709c3f78)

Set the **Refresh Time** and the Day to run.

![dsCONNECT User Guide - Step 64.jpeg](media://437ee3b9-a7c4-41d7-916e-a403463e62f8)




# Exporting Data

Data can be exported from the **SQL Express** tables in three formats:

1. **Excel** - Creates an Excel workbook with a tab for each table
2. **CSV** - Creates a CSV file for each table, named after the table name.
3. **Access DB** - Creates an Access database with an Access table for each Layout table.

When exporting data, all data from all tables will be exported.

![dsCONNECT User Guide - Step 67 (1).jpeg](media://6ba4d73b-7528-4549-932c-cb60abca7088)


Select the Export format and the Export file location and name, then click **Export Data Now**

![dsCONNECT User Guide - Step 73.jpeg](media://92e728da-7c5e-410f-8b22-674e4aa61145)


Click **Yes** to confirm to continue with the Export

![dsCONNECT User Guide - Step 74.jpeg](media://d4a002d1-6c3a-44a6-b376-b6ff266f32fc)


A progress bar will indicate the export status.

![dsCONNECT User Guide - Step 75.jpeg](media://0a30d06f-f517-4baa-af67-60b2de3047e6)


After the Export has completed, a message box displays with the results, click **OK** to close

![dsCONNECT User Guide - Step 76.jpeg](media://2d52af52-c43a-45d7-88ce-797c38345451)



# Settings

The Setting tab allows a user to check and edit the configuration parameters for the SQL Express database and the API connection to the DataShed MDS.

Data Export can also be run. Configuration settings can be Exported or Imported.

To access Settings, click the **Settings** tab

![DSCONNECT User Guide - Step 69.png](media://69453df2-c07e-464c-80be-4d731b002297)



## **Database Settings**

Click **Test Database Connection** to test the connection to your SQL Express.

![dsCONNECT User Guide - Step 86.jpeg](media://c46c7c59-fe21-40a4-a9fe-1e69a160151d)




A message box will display the Test results. Click **OK** to close.

![dsCONNECT User Guide - Step 87.jpeg](media://03860d60-68eb-4660-842a-d19ffc37269b)




## **Check the MDS Verision**

Click the **Re-check MDS Version** button

![dsCONNECT User Guide - Step 88.jpeg](media://9c844928-9a23-4380-b850-213f4d552c46)




A message box will display the details. Click **OK** to close the message box.

![dsCONNECT User Guide - Step 89.jpeg](media://06d99bf0-1526-4a07-8d9a-64105f976cdc)




## **Check the Environment Connections**

Click the **View/Edit Environment Configuration** button to

![dsCONNECT User Guide - Step 90.jpeg](media://8e8cdf11-db2f-4ebb-9b9c-983c9d0ca9f7)




A dialogue display showing two tabs and some action buttons at the lower left.

The **API** tab allows the API URL and the API Key to be updated.

![dsCONNECT User Guide - Step 91.jpeg](media://a247d28d-f26c-44a0-bce0-a2735a0a0f88)




The **Database Settings** tab allows the SQL Express settings to be modified.

![dsCONNECT User Guide - Step 92.jpeg](media://3b4cb70d-9ff6-49ff-903a-e3619dad3af6)




## **Test API Connection**

The **Test API Connection** button will test if the API is configured correctly

![dsCONNECT User Guide - Step 93 (1).jpeg](media://e5de9cc0-c3c3-4036-a113-1317289c175f)




A message box will display the results. Click **OK** to close.

![dsCONNECT User Guide - Step 94.jpeg](media://14c91b73-94b7-490e-9acf-8a8d75dfcdff)




## **Test the SQL Express Database Connection**

To test the SQL Express Database Connection, click the **Test Database Connection** button

![dsCONNECT User Guide - Step 95 (1).jpeg](media://a6eaf30a-7300-489c-b6a2-3bd8d2b94351)




A message box will display the results, click **OK** to close

![dsCONNECT User Guide - Step 96.jpeg](media://e95164c8-7a3a-42fc-9ad6-7220cd61f8ee)


## Export Configuration

The Export Configuration option will export the configuration to a JSON file. This file can be shared with team members and imported to make configurations quickly and consistently for multiple users.

To export the configuration, click **Export Configuration**

![dsCONNECT User Guide - Step 99.jpeg](media://92f64c07-75bc-4bce-bc70-8901047c0fde)




Enter a filename and select an export location, then click **Save**

![dsCONNECT User Guide - Step 100.jpeg](media://773886a6-3cde-4e13-952b-efd4bc42f65f)




A success message box will be displayed, click **OK** to close

![dsCONNECT User Guide - Step 101.jpeg](media://e460cacd-886b-4d24-8ef1-789b2b8fc426)



## Import Configuration

Configurations that have been exported from a users DSConnect can be imported to help speed up installation and keep all Users configurations the same.

Click **Import Configuration**.

![dsCONNECT User Guide - Step 103.jpeg](media://89e1c2ea-4ea0-49a7-8b41-936ce1a634d0)




Navigate to the file location annd select the JSON file, then click **Open**.

![dsCONNECT User Guide - Step 104.jpeg](media://d4b73248-93ac-4e58-8338-a99bd8f0f1ac)



The **Import Configuration** message box will display asking if you want to merge with existing configuration. **Yes** will merge with existing, meaning the configuration file settings will be added to the existing settings. **No** means the existing settings will be replaced with the settings in the JSON file.

![dsCONNECT User Guide - Step 105.jpeg](media://db0ec029-1785-486d-93f1-db93461b176a)



After the import has been done, a success message box will display. Click **OK** to close.


![dsCONNECT User Guide - Step 106.jpeg](media://d6bf3198-f842-4770-bf78-9b048aac6194)