Capabilities

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

Overview

The Data Agent reads XML files from a local or shared directory.

The Data Agent reads files changed in the last 2 hours, including files in subfolders.

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 FirstWatch XML files. The tables below show each GovWorx field and the source it comes from. Source names are elements of the XML file. The Data Agent reads them from the root element, except where the row says otherwise.

Note: Additional fields are considered enhancement requests.

Incident fields

GovWorx field	FirstWatch source	Notes
Incident ID	`SysId`
Incident Number	`Number`
Incident Type	`IncidentType`
Caller Number	`CallerNumber`
Caller Name	`CallerName`
Agency	`Agency`	The Agencies setting filters on this value.
Agency Type	`AgencyType`	The Data Agent also reads Agency_type and agency_type. The Agencies setting also matches on this value.
Incident Date	`IncidentDate`
Disposition	`Disposition`
Location	`Location`
Priority	`Priority`
Latitude	`Latitude`
Longitude	`Longitude`
Call Position	`CallPosition`
Call Taker ID	`CallTakerId`
Call Taker Name	`CallTakerName`
Call Received Time	`CallReceivedTime`	The earliest CAD note timestamp setting replaces this with the earliest note time.
Call Pickup Time	`CallPickupTime`
Call Hangup Time	`CallHangupTime`
Closed At	`ClosedAt`

Notes

GovWorx field	FirstWatch source	Notes
Note ID	`Notes/CADIncidentRecordNote/NoteID`	The Data Agent generates an ID when this is empty.
Note Text	`Notes/CADIncidentRecordNote/Note`
Note By	`Notes/CADIncidentRecordNote/NoteBy`
Note Time	`Notes/CADIncidentRecordNote/NoteAt`

Responders and units

GovWorx field	FirstWatch source	Notes
Personnel ID	`Responders/CADIncidentResponder/PersonnelId`
Unit Name	`Responders/CADIncidentResponder/UnitName`
Dispatched By	`Responders/CADIncidentResponder/DispatchedBy`
Dispatched At	`Responders/CADIncidentResponder/DispatchedAt`
Enroute At	`Responders/CADIncidentResponder/EnrouteAt`
Arrived At	`Responders/CADIncidentResponder/ArrivedAt`
Cleared At	`Responders/CADIncidentResponder/ClearedAt`

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
`UNC Share / Directory*`	Text	Either a local path or a UNC share path. Recognized as a UNC path if it begins with two backslashes ("\\").
`Username`	Text	Credential to access a UNC shared folder. Required for a UNC share path.
`Password`	Password	Credential to access a UNC shared folder. Required for a UNC share path.
`Delete files after being processed`	Toggle	Whether to delete each XML file after processing it.
`Agencies`	Text	If set, only include an incident if its agency contains an element of this comma-separated string. The Data Agent also includes an incident when its agency type equals an element.
`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 - FirstWatch