Capabilities
Capabilities | SQL | XML |
Connector Capabilities | ||
Read | Yes | Yes |
Backfill | Yes | No |
Bidirectional Capabilities | ||
Incident Create | No | No |
Incident Update | No | No |
Narrative Update | No | No |
Overview
SQL Connection
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.
XML Export
The Data Agent reads XML files from a local or shared directory.
⚠️ OneSolution Generic XMLs do not contain CAD positional data
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
Standard Data Fields
These are the standard data fields the Data Agent reads from Central Square OneSolution. The tables below show each GovWorx incident field and the OneSolution source it comes from. The Data Agent reads closed incidents.
Note: Additional fields are considered enhancement requests.
SQL: Incident fields
Source names are columns of the inmain table unless the row says otherwise.
GovWorx field | Central Square OneSolution source | Notes |
Incident ID |
| CAD record key. |
Incident Number |
| |
Incident Type |
| Leading and trailing spaces are removed. |
Caller Number |
| |
Caller Name |
| |
Agency |
| |
Agency Type |
| |
Incident Date |
| |
Disposition |
| |
Case Number |
| |
Location |
| The street column setting uses inmain.street. |
Initial Location |
| Only with the Initial Location setting on. The first address entered, or the earlier side of the first address change. |
Priority |
| |
Latitude |
| Numeric values only. |
Longitude |
| Numeric values only. |
Call Position |
| |
Call Taker ID |
| |
Call Taker Name |
| Looked up from the call taker ID. |
Call Source |
| |
Call Received Time |
| The log entry with transaction type TR. The earliest CAD note timestamp setting replaces this with the earliest note time. |
Closed At |
| The Data Agent reads incidents by close time. |
Dispatch Queue At |
| |
Response Area | inmain column of your choice | Only with the Response Area setting. |
Additional Context |
| Only with the additional context setting on. |
SQL: Notes
GovWorx field | Central Square OneSolution source | Notes |
Note ID |
| |
Note Text |
| |
Note By |
| Looked up from incinotes.userid. |
Note Time |
| |
Medical protocol note | incilog (transaction type MPS) | Only with the MPS setting on. The note text is Med. Pri Started (MPS). |
SQL: Responders and units
GovWorx field | Central Square OneSolution source | Notes |
Unit Name |
| |
Personnel ID |
| The person assigned to the unit. |
Dispatched By |
| From the D log entry. |
Dispatched At |
| The log entry with status D. |
Enroute At |
| The log entry with status E. |
Arrived At |
| The log entry with status A. |
Cleared At |
| The log entry with status C. |
External agency units |
| Only with the external agency setting on. Enroute At is not set. |
XML: Incident fields
Source names are elements in the EventDetails section of the XML file.
GovWorx field | XML element | Notes |
Incident ID |
| The Data Agent skips files without it. |
Incident Number |
| |
Incident Type |
| |
Caller Number |
| |
Caller Name |
| |
Agency |
| |
Incident Date |
| The Data Agent skips files without it. |
Disposition |
| |
Location |
| With a cross street and no street number, the format is Street / CrossStreet (XStreetName). |
Priority |
| |
Latitude |
| |
Longitude |
| |
Call Position |
| The CAD workstation operator. |
Call Taker ID |
| |
Call Taker Name |
| |
Call Source |
| |
Call Received Time |
| The earliest CAD note timestamp setting replaces this with the earliest note time. |
Closed At |
| Uses LastUnitClearTime when empty. OneSolution writes files as unit statuses change, so a file can arrive before the incident closes. |
Dispatch Queue At |
|
XML: Notes
GovWorx field | XML element | Notes |
Notes |
| Each entry that starts with a time and user in brackets becomes a note with that author and time. Text without a bracket becomes a note by the call taker. |
XML: Responders and units
Source names are elements in the EventUnits section of the XML file.
GovWorx field | XML element | Notes |
Unit Name |
| |
Personnel ID |
| One responder for each person on the unit. A unit with no people is one responder. |
Dispatched At |
| |
Enroute At |
| |
Arrived At |
| |
Cleared At |
|
Data Agent Settings
To prepare for this connection, we need the following details. These are settings in the GovWorx Data Agent configuration for this connector. A toggle is an on/off switch in that configuration.
SQL Connection
Setting | Type | Explanation |
| Text | The hostname or IP address of the SQL Server. For named instances, use the format HOSTNAME\INSTANCE or specify a custom port. |
| Toggle | Toggle will enable the use of a domain service account that is configured to run the agent service as authentication to SQL server |
| Text | A SQL Server-authenticated user with read-only permissions on the required database objects. |
| Password | The corresponding password for the SQL Server user account. |
| Text | The name of the target database schema from which the Data Agent will read data (e.g., OneSolutionReporting). |
| Toggle | Toggle will connect with multi-subnet failover on and a read-only application intent, so the connection goes to a readable secondary in an availability group. |
| Toggle | Toggle will apply the collation type below to the join conditions between tables. |
| Text | The collation applied to the join conditions. Used with the toggle above. |
| Toggle | Toggle will run several smaller queries in place of one large query. |
| Toggle | If the local database is replicated from the cloud, the query must be altered to reflect a table that isn't available locally. The Call Taker Name field of each incident and the Note By field of each note will not be populated. |
| Toggle | Toggle will add the count of premise, alert, and hotspot notifications shown, and which of them the call taker selected, to additional context. |
| Text | How far back each run looks for closed incidents. |
| Toggle | Toggle will query over a fixed time interval instead of time back, for backfilling historical data. |
| Text | Beginning time of the fixed interval. |
| Text | End time of the fixed interval. |
| Text | Splits the query into chunks. Blank disables splitting. |
| Toggle | Toggle will read from the views named below in place of the matching tables. |
| Text | View to read in place of the inmain table. |
| Text | View to read in place of the incilog table. |
| Text | View to read in place of the unitper table. |
| Text | View to read in place of the emmain table. |
| Text | View to read in place of the system1 table. |
| Text | View to read in place of the incinotes table. |
| Toggle | Toggle will use the street column as the location. |
| Toggle | Toggle will fill Initial Location with the first address entered, when it differs from the final location. |
| Toggle | Toggle will add a note with the time the call taker started medical protocols. |
| Text | Name of the inmain column to read as Response Area. Blank turns this off. |
| Toggle | Toggle will include responders from external agencies that use mobile units. |
| Text | Unit codes of the external agencies to include. Shown when the toggle above is on. |
| Number | Caps how far back a stale cursor can reach so an idle or reconnected connector does not issue an oversized catch-up query. Default: 8. |
| Toggle | Toggle will use the earliest CAD note time as Call Received Time. Use it when the first note marks the start of the call better than the CAD pickup time. Call Pickup Time does not change. When no note has a time, Call Received Time stays as read from CAD. Default: off. This setting is on every CAD connector. |
Note: Fields marked with an asterisk (*) are required.
XML Export
*: Required
**: Either Integrated Security or (Username and Password) is required.
Setting | Type | Explanation |
| Text | Either a local path or a UNC share path. Recognized as a UNC path if it begins with two backslashes ("\\"). |
| Toggle | Whether to use gMSA or explicit credentials |
| Text | Provide if using explicit credentials |
| Password | Provide if using explicit credentials |
| Toggle | Whether to delete each XML file after processing it. |
| Text | Look for files from up to this many hours back. |
| Toggle | Toggle will use the earliest CAD note time as Call Received Time. Use it when the first note marks the start of the call better than the CAD pickup time. Call Pickup Time does not change. When no note has a time, Call Received Time stays as read from CAD. Default: off. This setting is on every CAD connector. |
Need Help?
For questions about setting up the connection, or if you require assistance, please contact GovWorx Support at [email protected].
