Capabilities
Capabilities | Supported |
Connector Capabilities | |
Read | Yes |
Backfill | Yes |
Bidirectional Capabilities | |
Incident Create | No |
Incident Update | No |
Narrative Update | No |
Overview
The Data Agent will read from the SQL Reporting/Archive Database. CSI will create a SQL view for the GovWorx Data Agent to query. To do this we need a database reader user to connect.
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 CSI. The tables below show each GovWorx field and the column it comes from in the CSI SQL views.
Note: Additional fields are considered enhancement requests.
Incident fields
Source names are columns of the incidents view unless the row says otherwise.
GovWorx field | CSI source | Notes |
Incident ID |
| CAD record key. |
Incident Number |
| |
Case Number |
| |
Incident Type |
| |
Caller Number |
| |
Caller Name |
| |
Agency |
| |
Agency Type |
| |
Incident Date |
| |
Disposition |
| |
Location |
| |
Priority |
| |
Latitude |
| |
Longitude |
| |
Call Position |
| With the Map CallPosition from taker_desk setting on, this is the desk column of the incidents view. With the Enable CallPosition field mapping setting on instead, it is the column named in the desk view, matched on cfs_number. |
Call Taker ID |
| The Use CallTakerName as CallTakerId setting uses CallTakerName instead. |
Call Taker Name |
| |
Call Source |
| |
Call Received Time |
| The earliest CAD note timestamp setting replaces this with the earliest note time. |
Closed At |
| The CSI update time. With the default settings, the Data Agent reads incidents by this time where cad_event_status is CLOSED. |
Response Area |
|
Notes
Source names are columns of the notes view. The Data Agent matches notes to incidents on case_id.
GovWorx field | CSI source | Notes |
Note ID |
| |
Note Text |
| |
Note By |
| |
Note Time |
|
Responders and units
Source names are columns of the responders view. The Data Agent matches responders to incidents on case_id.
GovWorx field | CSI source | Notes |
Unit Name |
| |
Personnel ID |
| |
Dispatched By |
| |
Dispatched At |
| |
Enroute At |
| |
Arrived At |
| |
Cleared At |
|
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 |
| Text | Host of the reporting database |
| Text | Database Schema to read from |
| Toggle | Toggle will enable the use of a domain service account that is configured to run the agent service as authentication to SQL server |
| Text | Database user |
| Password | Database password |
| Text | Database SQL View Name for CAD Incident data. Default: VCAD_EVENT_CFS_GovWorx. |
| Text | Database SQL View Name for CAD Narrative/Comments data. Default: VCAD_EVENT_CFS_GovWorx_Note. |
| Text | Database SQL View Name for CAD Responder data. Default: VCAD_EVENT_CFS_GovWorx. |
| Text | Database SQL View Name for the desk or position data. Default: VCAD_EVENT_CFS_GovWorx_Desk. Used only with the Enable CallPosition field mapping setting. |
| Text | How far back each run looks for incidents. Default: 30. |
| Toggle | Toggle will query over the fixed time interval below instead of the minutes back, for backfilling historical data. |
| Text | Beginning time of the backfill interval, in local server time. |
| Text | End time of the backfill interval, in local server time. |
| Toggle | Toggle will use the call taker name in place of the call taker ID. |
| Toggle | Toggle on reads incidents with status CLOSED by last updated time. Toggle off reads incidents by incident date. Default: on. |
| Toggle | Toggle will read the call position from the desk view. |
| Text | Name of the column in the desk view that holds the call position. |
| Toggle | Toggle will read the call position from the desk column of the incidents view. This takes precedence over the desk view setting. |
| 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. |
| 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. |
