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

The GovWorx Data Agent has the capabilities to browse a file share and pull CAD information located within XML files. Southern Software Solutions can be configured to export XML files that hold the information needed for processing by the Data Agent. It is recommended to have CAD export the XML at the time the call is closed.

XML Data Elements

The more data sent to GovWorx, the richer the experience will be. That said, sometimes certain CADs don't track data points, or other reasons to not get the data. View the CAD Data Element requirements and recommendations here.

View CAD Data Elements

Standard Data Fields

These are the standard data fields the Data Agent reads from Southern Software Solutions. The tables below show each GovWorx incident field and the XML element it comes from. Source names are elements at the top level of the XML file unless the row says otherwise.

Note: Additional fields are considered enhancement requests.

Incident fields

GovWorx field	XML element	Notes
Incident ID	`CFSNumber`
Incident Number	`CFSNumber`
Case Number	`OCAList / OCA`	All OCA entries, joined with commas.
Incident Type	`CallType`
Caller Number	`CallerPhone`
Caller Name	`CallerName`
Agency	`ELTL, ELTF, ELTE`	The law, fire, and EMS agency values, joined with commas.
Incident Date	`CreateWhen`
Disposition	`Disposition`
Location	`IncStreetNum, IncStreetName, IncCommunity, State`
Street Number	`IncStreetNum`	Blank when the location is an intersection.
Street Name	`IncPreDir, IncStreetName`	For an intersection, the Data Agent uses IncIntersection. When IncStreetName is missing, it uses IncStreetBase, IncStreetType, and IncPostDir.
City	`IncCommunity`
State	`State`
Cross Street 1	`CrossLow`
Cross Street 2	`CrossHigh`
Location Name	`IncLandName`
Priority	`AlarmLevel`
Latitude	`YCoor`
Longitude	`XCoor`
Call Position	`PositionID`
Call Taker ID	`CreateBy`
Call Taker Name	`CreateBy`
Call Source	`HowReceived`
Call Received Time	`CFSStartWhen`	The earliest CAD note timestamp setting replaces this with the earliest note time.
Closed At	`ClosedOn, ClosedWhen`	The Data Agent uses ClosedWhen when ClosedOn is missing. It skips files for incidents that are still open, unless the merge setting is on.
Additional Context	`MedDispatchLevel`

Notes

GovWorx field	XML element	Notes
Note Text	`CFSNotes / CFSNote / NoteText`
Note By	`CFSNotes / CFSNote / CreateBy`
Note Time	`CFSNotes / CFSNote / CreateWhen`
Initial statement note	`Comment`	Only with the Include Initial Statement Comment setting on. The note author is CreateBy and the note time is CreateWhen of the incident.

Responders and units

Source names are elements inside each Unit element.

GovWorx field	XML element	Notes
Unit Name	`UnitCFSEvents / Unit / UnitID`	One responder for each unit.
Personnel ID	`PersonnelIDList / PersonnelID`	The first person listed on the unit.
Dispatched By	`CreateBy`	The incident creator.
Dispatched At	`Dispatch / When`	Uses FirstUnitDispatchWhen when the unit has no dispatch time.
Arrived At	`Arrive / When`
Cleared At	`Clear / When`

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	File location of the XML files created by CAD. The Data Agent reads all XML files in this folder and its subfolders. A path that begins with two backslashes is a UNC share path. Otherwise the Data Agent treats it as a local path.
`Username**`	Text	If file share requires separate credentials for access. GovWorx service account Username.
`Password**`	Password	If file share requires separate credentials for access. GovWorx service account Password.
`Delete files after being processed`	Toggle	Optional: Toggle will enable the deletion of XML files after the data agent has processed the file. Recommended this setting be turned off till data integration is complete and verified.
`Agencies`	Text	Comma-separated list of agency codes. The Data Agent processes only the files where the law, fire, or EMS agency contains one of these values. Blank processes all files.
`Include Initial Statement Comment`	Toggle	If true, use an incident's Comment (in the XML) as the first note, then add notes from CFSNotes
`Merge notes from open XML snapshots into the first closed upload`	Toggle	Toggle will read every XML file for an incident, including the files written while the incident was open. The Data Agent then uploads the newest closed file with the notes from all files for that incident, without duplicates.
`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

**: Required when the directory is a UNC share path.

CAD Connector - Southern Software Solutions