SQL Connection
Overview
The GovWorx Data Agent connects to the Central Square OneSolution Reporting Database using a direct SQL connection. A dedicated read-only database user is required to ensure security and data integrity.
What Youโll Need
To prepare for the connection between the GovWorx Data Agent and your SQL Server, please gather the following configuration details:
Configuration | Explanation |
| The hostname or IP address of the SQL Server. For named instances, use the format |
TOGGLE: | Toggle will enable the use of a domain service account that is configured to run the agent service as authentication to SQL server |
| A SQL Server-authenticated user with read-only permissions on the required database objects. |
| The corresponding password for the SQL Server user account. |
| The name of the target database schema from which the Data Agent will read data (e.g., |
TOGGLE: |
|
TOGGLE: |
|
|
|
TOGGLE: |
|
TOGGLE: | If the local database is replicated from the cloud, the query must be altered to reflect a table that isn't available locally. |
Note: Fields marked with an asterisk (*) are required.
SQL Server Configuration Notes
To ensure a successful and secure connection, verify the following:
Firewall Access: Ensure the server hosting the GovWorx Data Agent can reach the SQL Server over the appropriate network and port (typically TCP 1433).
Minimum Permissions: The provided database user must have read-only access to relevant tables, views, or stored procedures. Write access is not required or recommended.
Instance Visibility: If using a named instance, confirm SQL Server Browser service is running, or explicitly provide the port number.
Troubleshooting Tips
Login Failed? Verify the SQL user is enabled and not locked out.
Timeout Errors? Check network routes and firewall rules.
Invalid Database? Ensure the
databasefield in the config matches the actual schema name.
Network Requirements: The server running the Data Agent should be able to connect to the CAD Reporting server over port 1433. This can be tested using PowerShell.
PowerShell Command:
Test-NetConnection -ComputerName {CAD Reporting Server name or IP} -Port 1433
๐ XML Export
Overview
The Data Agent reads XML files from a local or shared directory.
โ ๏ธ OneSolution Generic XMLs do not contain CAD positional data
*: Required
**: Either Integrated Security or (Username and Password) is required.
Configuration | Explanation |
UNC Share / Directory* | Either a local path or a UNC share path. Recognized as a UNC path if it begins with two backslashes ("\\"). |
Use Integrated Security** | Whether to use gMSA or explicit credentials |
Username** | Provide if using explicit credentials |
Password** | Provide if using explicit credentials |
Delete files after being processed | Whether to delete each XML file after processing it. |
Hours back | Look for files from up to this many hours back (default: 2). |
Need Help?
For questions about setting up the connection, or if you require assistance, please contact GovWorx Support at [email protected].
