Capabilities

Capabilities	Supported
Connector Capabilities
Read	Yes
Backfill	No
Bidirectional Capabilities
Incident Create	No
Incident Update	No
Narrative Update	No

Overview

The Data Agent connects to the Hexagon OnCall SQL Server database with read-only access. It reads closed incidents, their notes, and the status history of their units.

The Data Agent reads incidents whose closing time is later than the start of its window. The window starts at the last incident it read. On the first run it starts at the first-run lookback. The Maximum lookback setting caps the window. The Data Agent uses the SQL Server clock in UTC to set the window.

No CAD data is stored on the local server running the Data Agent.

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 database field in the config matches the actual schema name.
No notes or responders? Verify the database user can read the CommonEventComment and ActiveUnitHistory tables.

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 Hexagon OnCall. The tables below show each GovWorx field and the column it comes from. Incident fields come from the agencyevent table and the tables joined to it.

Note: Additional fields are considered enhancement requests.

Incident fields

GovWorx field	Hexagon OnCall source	Notes
Incident ID	`CommonEventId`	CAD record key.
Incident Number	`AgencyEventId`
Incident Type	`agencyeventtypecodedesc, agencyeventsubtypecodedesc`	Joined as type \| subtype. Uses the type alone when there is no subtype.
Agency	`AgencyId`
Priority	`priority`
Incident Date	`CreatedTime`
Location	`CommonEventLocation.Location`
Call Source	`commoneventcall.CallSource`
Caller Name	`commoneventcall.CallerName`
Caller Number	`commoneventcall.CallerPhoneNumber`
Call Position	`CreatedPositionId`
Call Taker ID	`CreatedEmployeeId`
Call Taker Name	`DefinedEmployee.FirstName, LastName`	Joined with a space.
Call Pickup Time	`StartedTime`
Closed At	`ClosingTime`	The Data Agent reads closed incidents only.

Notes

GovWorx field	Hexagon OnCall source	Notes
Note ID	`CommonEventComment.Id`
Note Text	`commenttext`
Note By	`CreatedEmployeeId`
Note Time	`createdtime`

Responders and units

GovWorx field	Hexagon OnCall source	Notes
Unit Name	`ActiveUnitHistory.unitid`	Matches the unit to the incident by AssignedAgencyEventId.
Responder ID	`ActiveUnitHistory.unitid`
Dispatched By	`CreatedEmployeeId`
Dispatched At	`CreatedTime, action code 29`	Uses the earliest time for each action code.
Enroute At	`CreatedTime, action code 32`
Arrived At	`CreatedTime, action code 1`
Cleared At	`CreatedTime, action code 26`

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.

Setting	Type	Explanation
`Host*`	Text	Host of the CAD reporting database
`Use Integrated Security**`	Toggle	Toggle will enable the use of a domain service account that is configured to run the agent service as authentication to SQL server
`Username**`	Text	SQL reader username
`Password**`	Password	SQL reader password
`Database name*`	Text	Database to read from
`First-run lookback in hours`	Number	Hours back to look on the first run, when no earlier run exists. Default: 1.
`Maximum lookback in hours`	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.
`Use earliest CAD note timestamp for Received At`	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.

*: Required

**: Either Integrated Security or (Username and Password) is required.

CAD Connector - Hexagon OnCall