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

This connector is distinct from that which uses Central Square ProSuite's report system. See that article here.

The data agent connects directly to Central Square ProSuite's API.

Authentication

The data agent requests a bearer token when necessary via a password grant request to the OAuth 2.0 authentication endpoint. This bearer token is used for as long as possible to make requests to other API endpoints.

Endpoint usage

The data agent makes requests only to non-modifying endpoints; that is, POST /search or GET endpoints.

Standard Data Fields

These are the standard data fields the Data Agent reads from the Central Square ProSuite API. The tables below show each GovWorx field and the source it comes from. Source names are fields of the CFS record returned by the API. The Data Agent reads incidents closed in the last hour.

Additional fields are considered enhancement requests.

Incident fields

GovWorx field	ProSuite API source	Notes
Incident ID	`CfsNumber`	The Data Agent skips records without it.
Incident Number	`CfsNumber`
Incident Type	`IncidentCode[0].Code`	The first incident code.
Caller Number	`Reporter.FromPhoneNumber`
Caller Name	`Reporter.FreeformFullName`
Agency	`DispatchAgency.Abbreviation`
Agency Type	`DispatchAgency.Name`
Incident Date	`IncidentDateTime`
Disposition	`Disposition[].Code`	The disposition marked primary.
Case Number	`Case[0].CaseNumber`	The first case.
Location	`Address.Street, Address.City`	Joined as Street, City. If one is missing, the other alone.
Priority	`Priority`
Latitude	`Address.Latitude`
Longitude	`Address.Longitude`
Call Taker ID	`CallTaker.UniqueIdentifier`
Call Taker Name	`CallTaker.Username`
Closed At	`CommandLog[].Timestamp`	The first command log entry with tag complete.

Notes

GovWorx field	ProSuite API source	Notes
Note Text	`CommandLog[].Text`	One note for each command log entry with tag log.
Note By	`CommandLog[].Creator.Username`
Note Time	`CommandLog[].Timestamp`

Responders and units

Unit times come from the cfs_analytics endpoint.

GovWorx field	ProSuite API source	Notes
Unit Name	`Unit[].UnitNumber`
Personnel ID	`Unit[].Responder.Username`
Dispatched By	`DispatchAgency.DispatchedBy`
Dispatched At	`cfs_analytics Unit[].UnitTimes.Dispatched`	Matched to the unit by unit number.
Enroute At	`cfs_analytics Unit[].UnitTimes.Enroute`
Arrived At	`cfs_analytics Unit[].UnitTimes.OnScene`
Cleared At	`cfs_analytics Unit[].UnitTimes.Available`

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
`Base URL*`	Text	The base API URL. Endpoint URLs are constructed using this.
`Username*`	Text	Username for acquiring bearer tokens.
`Password*`	Password	Password for acquiring bearer tokens.
`Domain (for Active Directory)`	Text	Required if using Active Directory for authentication.

*: Required

CAD Connector - Central Square ProSuite API