Capabilities

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

Overview

The GovWorx Data Agent connects to the Cyrun Reporting/Replicated Database using a direct SQL connection. A dedicated read-only database user is required to ensure security and data integrity.

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.

Standard Data Fields

These are the standard data fields the Data Agent reads from Cyrun. The tables below show each GovWorx incident field and the Cyrun column it comes from. The Data Agent reads incidents with Status Closed, selected by creation time. Source names are EventMaster columns unless the row says otherwise.

Note: Additional fields are considered enhancement requests.

Incident fields

GovWorx field	Cyrun source	Notes
Incident ID	`EventMaster.EventNum`	CAD record key.
Incident Number	`EventMaster.EventNum`
Incident Type	`EventMaster.DeptCode`	Replaced by EventCodes.Description when a match exists.
Initial Incident Type	`EventMaster.OrigDeptCode`	Replaced by EventCodes.Description when a match exists.
Caller Number	`ComplainantMaster.PhoneNum`	The first complainant for the incident.
Caller Name	`ComplainantMaster.CompLast, CompFirst`	The first complainant. The format is Last, First.
Agency	`EventMaster.Police, Fire, EMS`	PD, FD, or EMS. The first flag that is set to 1, Y, T, or true.
Incident Date	`EventMaster.DtCreated`
Disposition	`EventMaster.Disposition`
Location	`EventMaster.Number, Street, Apt, City, Location`	Joined with spaces. Empty values are skipped.
Priority	`EventMaster.Hot`
Latitude	`EventMaster.Latitude`
Longitude	`EventMaster.Longitude`
Call Position	`LogonHistory.WorkStation`	The most recent logon of the call taker before the incident started. Prefers DISPATCHER and DispatchLead logons. The Data Agent looks back 24 hours before the first incident in the batch.
Call Taker ID	`EventMaster.ReceivingDisp`
Call Received Time	`EventMaster.DtCreated`	The earliest CAD note timestamp setting replaces this with the earliest note time.
Closed At	`EventMaster.TimeCleared`	The Data Agent reads incidents with Status Closed.
Dispatch Queue At	`EventMaster.TimeDispatched`
Response Area	`EventMaster.Beat`
Additional Context	`EventMaster.Location`	The named location, such as a building.
Related Incident	`EventMaster.RelatedEvents`

Notes

GovWorx field	Cyrun source	Notes
Note Text	`EventNotes.Notes`
Note By	`EventNotes.Dispatcher`
Note Time	`EventNotes.DateTime`

Responders and units

GovWorx field	Cyrun source	Notes
Unit Name	`EventOfficers.UnitID`
Personnel ID	`EventOfficers.OfficerID`
Dispatched At	`EventOfficers.AssignedDT`
Enroute At	`EventOfficers.EnRouteDT`
Arrived At	`EventOfficers.ArrivedDT`
Cleared At	`EventOfficers.ClearedDT`

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.

*: Required.

**: Either Use integrated security or (Username and Password) is required.

Setting	Type	Explanation
`Host*`	Text	The hostname or IP address of the SQL Server. For named instances, use the format HOSTNAME\INSTANCE or specify a custom port.
`Database name*`	Text	The name of the target database schema from which the Data Agent will read data (e.g., OneSolutionReporting).
`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	A SQL Server-authenticated user with read-only permissions on the required database objects.
`Password**`	Password	The corresponding password for the SQL Server user account.
`Time back to query ([days.]hh:mm) (default 00:30, 30 minutes)`	Text	How far back each run looks for closed incidents. The Data Agent compares this to the incident creation time. Default: 00:30.
`Backfill enabled (overrides "Time back")`	Toggle	Toggle will query over a fixed time interval instead of time back, for backfilling historical data.
`Backfill: Beginning time (yyyy-mm-dd hh:mm)`	Text	Beginning time of the fixed interval.
`Backfill: End time`	Text	End time of the fixed interval.
`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.

Need Help?

For questions about setting up the connection, or if you require assistance, please contact GovWorx Support at [email protected].

CAD Connector - Cyrun