Capabilities

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

Customers of this CAD may be able to use bidirectional capabilities through IntelliComm. See Bidirectional CAD Integrations.

Overview

If your agency's voice logger maps recordings to agent identifiers, prefer the direct API connection. If the voice logger maps recordings to positions, use the connection method this article describes.

Central Square Pro Suite provides a robust reporting suite that can be exposed via interfaces. The high level steps to expose a set of data from a report is to

Create a Report - Create a report with the required fields
Create an Interface User - This only needs to be done once and can be reused across interfaces
Create an Interface - Create an interface and link the report to an interface. The interface description will determine the url to consume the interface

Once creating an interface you can test it works by browsing to the following URL

https://{agency}.zuercherportal.com/interfaces/{interfacename}.json?username={interfaceusername}&password={interfaceuserpassword}

So a full URL based on a created interface might be

https://{agency}.zuercherportal.com/interfaces/govworxincidents.json?username=govworx&password=govworx

Our data agent will read these endpoints from within the network. Our data agent expects a set of interfaces specifically named and with field names case sensitive and exact.

Required Interfaces

Incidents

Interface Name: govworxincidents

Report Main Item: CFS

CS Pro Field	Interface Field Name
CFS #	CFS_number
Priority	Priority
Primary Incident Code → Code : Description	Code_Description
CFS Date/Time	CFS_Date_Time
From Phone	From_Phone
Initial Reporter → Person/Business	Person_Business_Name
Primary Disposition → Code with Description	Code_With_Description
Address → Address	Address
Responder Agencies	Agency
Dispatcher → Username	Username
Dispatcher → Name → Last, First Name	Call_Taker_Name
911 Call → Received Time	Call_Received_Time
Completed Date/Time	Completed_Date_Time

Add filter to the govworxincidents report:

CFS Date/Time
Completed Date/Time

Incident Notes

Interface Name: govworxincidentnotes

Report Main Item: CAD Command Log

Interface Filter: CFS_number

CS Pro Field	Interface Field Name
CFS #	CFS_number
Date/Time	Date_Time
Personnel → Name → Last, First Name	Last_First_Name
Command / Message	Command_Message

Incident Audit Trail

Interface Name: govworxincidentaudit

Report Main Item: Audit Trail

Interface Filter: Record_number

CS Pro Field	Interface Field Name
Record #	Record_number
Computer Name	Computer_Name
Date	Date
User → Username	Username

Incident Responders

Interface Name: govworxincidentresponders

Report Main Item: CFS Units OR CFS Responders

Interface Filter: CFS_number

CS Pro Field	Interface Field Name
CFS → CFS #	CFS_number
Unit → Unit	Unit
CFS → Dispatcher → username	Username
CFS → First Assigned Date/Time	First_Assigned_Date_Time
CFS → First Enroute Date/Time	First_Enroute_Date_Time
CFS → First On Scene Date/Time	First_On_Scene_Date_Time
CFS → Completed Date/Time	Completed_Date_Time

Standard Data Fields

These are the standard data fields the Data Agent reads from Central Square ProSuite. The tables below show each GovWorx field and the source it comes from. Source names are fields of the interface JSON, unless the row says otherwise.

Additional fields are considered enhancement requests.

Incident fields

GovWorx field	ProSuite source	Notes
Incident ID	`CFS_number`	The Data Agent skips rows without it.
Incident Number	`CFS_number`
Incident Type	`Code_Description`
Caller Number	`From_Phone`
Caller Name	`Person_Business_Name`
Agency	`Agency`
Incident Date	`CFS_Date_Time`
Disposition	`Code_With_Description`
Location	`Address`
Priority	`Priority`
Call Taker ID	`Username`
Call Taker Name	`Call_Taker_Name`
Call Source	`Source`
Call Received Time	`CFS_Date_Time`	The earliest CAD note timestamp setting replaces this with the earliest note time.
Call Pickup Time	`CFS_Date_Time`
Closed At	`Completed_Date_Time`
Call Position	Computer_Name (audit interface)	The earliest audit entry for the call taker. With the most recent record setting, the latest entry for the call taker username. Not set when audit processing is off.
Dispatcher	Username (audit interface)	Only with the dispatcher workstation setting. The user of the earliest audit entry from a listed computer.

Notes

GovWorx field	ProSuite source	Notes
Note Text	`Command_Message`
Note By	`Last_First_Name`
Note Time	`Date_Time`

Responders and units

GovWorx field	ProSuite source	Notes
Unit Name	`Unit`
Dispatched By	`Username`
Dispatched At	`First_Assigned_Date_Time`
Enroute At	`First_Enroute_Date_Time`
Arrived At	`First_On_Scene_Date_Time`
Cleared At	`Completed_Date_Time`

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	Location of interface reports (https://{agency}.zuercherportal.com/interfaces)
`Username*`	Text	Interface Username
`Password*`	Password	Interface Password
`Incidents Interface (govworxincidents)`	Text	Name of the incidents interface. Blank uses govworxincidents.
`Incident Responders Interface (govworxincidentresponders)`	Text	Name of the incident responders interface. Blank uses govworxincidentresponders.
`Incident Notes Interface (govworxincidentnotes)`	Text	Name of the incident notes interface. Blank uses govworxincidentnotes.
`Incident Audit Interface (govworxincidentaudit)`	Text	Name of the incident audit interface. Blank uses govworxincidentaudit.
`Use Most Recent Record for Audit Interface`	Toggle	Toggle will look up the audit interface by call taker username only, and use the most recent entry to set Call Position.
`Disable audit log processing`	Toggle	Toggle will skip the audit interface. Call Position and the dispatcher are not set.
`Dispatcher Workstation PC Name(s) for audit-based dispatcher lookup (comma-separated)`	Text	Computer names of dispatcher workstations. The Data Agent finds the earliest audit entry from one of these computers and records its user as the dispatcher. Does not apply when the most recent record toggle is on.
`HTTP Request Timeout (ms)`	Number	How long the Data Agent waits for each interface request, in milliseconds. Default: 120000 (2 minutes). Raise it when ProSuite takes longer than 2 minutes to return a report and requests time out, for example 180000 (3 minutes). A blank or invalid value uses the default.
`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

CAD Connector - Central Square ProSuite via RESTful Export