Capabilities

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

Bidirectional capabilities apply to ASSIST and NEAL. See Bidirectional CAD Integrations.

Overview

The Data Agent will read from the Central Square Enterprise Reporting Database. To do this we need a user to connect.

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.

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 Enterprise. The Data Agent reads closed incidents that have an incident type. The tables below show each GovWorx incident field and the Central Square Enterprise column it comes from. Source names are Response_Master_Incident columns unless the row says otherwise. Edits made after an incident closes are also picked up.

Note: Additional fields are considered enhancement requests.

Incident fields

GovWorx field	Central Square Enterprise source	Notes
Incident ID	`Response_Master_Incident.ID`	CAD record key.
Incident Number	`Master_Incident_Number`	Uses Confirmation_Number when the first value is empty. The Confirmation Number setting reverses the order. The suffix setting adds text after Confirmation_Number.
Case Number	`CaseNumber.CaseNumber`	All case numbers for the incident, joined with commas.
Incident Type	`Problem`	The Code - Description setting reads Problem.Code and Problem.Description.
Initial Incident Type	`Problem`	With the Initial Incident Type setting on, this is the value before the last edit, read from Response_Edit.
Initial Location	`Response_Edit (Address)`	With the Initial Incident Location setting on, this is the first address entered. GovWorx uses Location when this is empty.
Caller Number	`Call_Back_Phone`
Caller Name	`Caller_Name`	The caller location setting adds Caller_Location_Name. The Deactivate setting removes the name.
Agency	`Jurisdiction`
Agency Type	`Agency_Type`
Incident Date	`Response_Date`	Uses Time_CallEnteredQueue when empty. The Event Date setting reverses the order.
Disposition	`ResponseDisposition.Disposition`	All dispositions, joined with commas.
Location	`Address, Apartment`	The Location_Name settings add the premise name.
Priority	`Priority_Number`
Latitude	`Latitude`
Longitude	`Longitude`
Call Position	`MachineName`	The call taker workstation.
Call Taker ID	`Personnel.EMP_ID`	Matches Personnel to CallTaking_Performed_By. Uses EMP_NAME when EMP_ID is empty. Two settings use the name as the ID or strip a letter prefix.
Call Taker Name	`CallTaking_Performed_By`
Call Source	`Caller_Type`	Uses MethodOfCallRcvd when empty. The Method of Call setting reverses the order.
Call Received Time	`Time_PhonePickUp`	The earliest CAD note timestamp setting replaces this with the earliest note time.
Call Pickup Time	`Time_FirstCallTakingKeystroke`
Call Hangup Time	`Time_CallTakingComplete`
Closed At	`Time_CallClosed`
Dispatch Queue At	`Fixed_Time_CallEnteredQueue`
Radio Channel	`Primary_TAC_Channel`
Response Area	`ResponseArea`	The Data Agent reads this only when the column exists in the database.
Additional Context	`Premise and caution flags, a custom view, or RPCont`	Each source is a setting. Not available with a stored procedure.
Related Incident	`MultiAgencyIncident.ParentIncidentId`	Only with the Relate linked incidents setting on.

Notes

GovWorx field	Central Square Enterprise source	Notes
Note ID	`Response_Comments.ID`
Note Text	`Response_Comments.Comment`	Confidential notes stay out unless the Include Confidential Notes setting is on.
Note By	`Response_Comments.Performed_By`
Note Time	`Response_Comments.Date_Time`

Responders and units

GovWorx field	Central Square Enterprise source	Notes
Unit Name	`Response_Vehicles_Assigned.Radio_Name`
Personnel ID	`Personnel.Emp_ID`	The person assigned to the unit.
Personnel Name	`Response_Vehicles_Personnel.Name`
Dispatched By	`Personnel.Emp_ID`	Matches Personnel to Assign_Performed_By.
Dispatched At	`Time_Assigned`
Enroute At	`Time_Enroute`
Arrived At	`Time_ArrivedAtScene`
Cleared At	`Time_Call_Cleared`

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 reporting database
`Username*`	Text	Database user
`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
`Password*`	Password	Database password
`Database*`	Text	Database Schema to read from
`Use Stored Procedure Query`	Toggle	Toggle on will cause the agent to query a SP in SQL. GovWorx will assist in the query fields needed to be returned from SP.
`Stored Procedure Name`	Text	Name of SP in SQL. Default: GW_CentralSquareInform
`Time back to query`	Text	Time back to query (hh:mm, default 01:00 = 1 hour). Inline SQL query only.
`Query over a fixed time interval`	Toggle	Toggle will query over a fixed time interval instead of time back, for backfilling historical data. Inline SQL query only.
`Fixed interval: beginning time`	Text	Beginning time of the fixed interval (yyyy-MM-dd HH:mm, local server time)
`Fixed interval: end time`	Text	End time of the fixed interval (yyyy-MM-dd HH:mm, local server time)
`Split fixed range into chunks`	Text	Splits the fixed range into chunks no longer than this (hh:mm) to avoid query timeouts. Default 01:00.
`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 Method of Call Received for Call Source`	Toggle	Toggle will enable Method of Call Received field from Response_Master_Incident table to be used for CommsCoach Call Source
`Use Confirmation Number for Event Number`	Toggle	Toggle will enable Confirmation Number field from Response_Master_Incident table to be used for CommsCoach Event Number
`Append suffix to confirmation numbers`	Text	Text appended to confirmation numbers (leave blank to disable)
`Use Time_CallEnteredQueue as CommsCoach Event Date`	Toggle	Toggle will use Time_CallEnteredQueue from Response_Master_Incident table as CommsCoach Event Date
`Append Location_Name after Address in Location`	Toggle	Toggle will append the Premise Name field from CAD to the CAD Address (on: 123 Main Street - Starbucks) (off: 123 Main Street)
`Format Location as Location_Name ; Address`	Toggle	Toggle will format Location as Location_Name ; Address (on: Starbucks ; 123 Main Street) Takes precedence over the toggle above.
`Include caller location in caller name field`	Toggle	Toggle will append the Caller Location field from CAD to the CAD Caller name (on: John Smith - Starbucks Parking Lot) (off: John Smith)
`Deactivate callerName (takes precedence over caller location option)`	Toggle	Toggle will disable the caller name entirely. If this is configured true, the above parameter (Include caller location) is ignored.
`Filter Out Cloned Incidents`	Toggle	Toggle will enable SQL query to check the linked incidents table and not pull any CAD incidents into CommsCoach that were cloned from other CAD Incidents (i.e. "ADD AGENCY")
`Relate linked incidents`	Toggle	Toggle will relate linked incidents in CommsCoach
`Use Call Taker Name as Call Taker ID`	Toggle	Toggle will use the call taker name in place of the Call Taker ID
`Strip alphabetical prefix from Call Taker ID`	Toggle	Toggle will strip the alphabetical prefix from the Call Taker ID (e.g., CT133381 becomes 133381)
`Include Confidential Notes`	Toggle	Toggle will include confidential notes. Confidential notes are excluded by default.
`Include Initial Incident Type`	Toggle	Toggle will populate Initial Incident Type with the incident type from before its last edit
`Include Initial Incident Location`	Toggle	Toggle will populate Initial Location with the first address entered
`Agency Type (NOT IN)`	Text	Comma separated values to list agency types to exclude from data query
`Jurisdiction (IN)`	Text	Comma separated values to list jurisdictions to include in the data query
`Add premise info to additional context`	Toggle	Add information about premise and caution notes to the "additional context" field of each incident. Disabled when using a stored procedure. Do not turn this on with the custom view toggle. The Data Agent stops reading incidents when both are on.
`Add additional context in custom view`	Toggle	Toggle will add text from the custom view named below to Additional Context. Do not turn this on with the premise toggle. Disabled when using a stored procedure.
`Additional context custom view name`	Text	Name of the custom view to read additional context from. The view needs an id column that matches Response_Master_Incident.ID and a text column. Required when the custom view toggle is on.
`Append RP Contact to additional context`	Toggle	Toggle will append RP Contact (RPCont from Response_Master_Incident) to additional context
`Format Incident Type as Code - Description`	Toggle	Requires dbo.problem table access
`Hours back to look for post-close edits`	Number	Hours back to look in Response_Edit for post-close edits on first run. Later runs resume from cursor. 0 disables. Default: 24.
`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.

Note: Fields marked with an asterisk (*) are required. When using a stored procedure, the stored procedure returns the incident fields. The time range, call taker ID, location format, initial location, and additional context settings do not apply.

Bidirectional connector settings

Bidirectional capabilities use a second connector on the same Data Agent. It runs on a machine with the Central Square Enterprise client installed.

Setting	Type	Explanation
`CAD Service Account`	Text	Name of the CAD service account the connector signs in with. Default: CAD Connector Service
`CAD Install Path`	Text	Folder of the Central Square Enterprise client. Default: C:\TriTech\VisiCAD\NET\

CAD Connector - CentralSquare Enterprise