Skip to main content

CAD Connector - Hexagon XML

GovWorx integration guide for the Hexagon XML CAD system.

Written by Kevin Biegert

Capabilities

Capabilities

Supported

Connector Capabilities

Read

Yes

Backfill

No

Bidirectional Capabilities

Incident Create

No

Incident Update

No

Narrative Update

No

Overview

The GovWorx Data Agent processes XML files generated by Hexagon CAD at the close of each call. These XML files contain call and incident metadata and are written by the CAD system to a local or shared directory, where the Data Agent securely reads and ingests them for downstream processing.

Each XML file represents a completed call event and is processed once it becomes available in the configured directory.

How the Connector Works

  1. Call Completion

    When a call is closed in Hexagon CAD, the system generates an XML file containing call and incident metadata.

  2. File Detection

    The GovWorx Data Agent monitors the configured directory for new XML files.

  3. XML Processing

    Each XML file is parsed and processed once it is fully written by the CAD system.

  4. Post-Processing Handling

    • If enabled, processed XML files are deleted.

    • If not enabled, files remain in place for auditing or retention purposes.

Directory and Access Requirements

  • The directory must be accessible from the Data Agent host.

  • The Data Agent requires read access at minimum.

  • If file deletion is enabled, delete permissions are also required.

  • A dedicated service account is strongly recommended to support auditing and least-privilege access.

Best Practices

  • One File Per Call: Ensure Hexagon CAD is configured to generate a single XML file per closed call.

  • Write Completion: Confirm files are fully written before being accessed by the Data Agent.

  • Retention Strategy: If files are not deleted, implement a retention or cleanup policy to prevent directory growth.

  • Consistent Timing: Avoid manual edits or delayed writes that could cause files to fall outside the configured “Time back to query” window.

Uploading closed incidents only

The "Only upload incidents that have a close time" setting holds each incident until its XML has a usable close time. It works with the standard export and the IFCADDEX custom report.

Before you turn it on: Confirm that Hexagon CAD writes a new or updated XML file when an incident closes. That file must have a close time and the final notes and units. It must arrive inside the "Time back to query" window. The Data Agent finds files by the time they were last written. An old file that stays in the folder does not get read again. If the export never writes completed incidents, the setting can hold the whole feed. The Data Agent does not release a held incident because it is old. A disposition does not count as a close time.

This setting does not fix incidents that already uploaded with incomplete data.

Call taker from the first call

On a copied event, the agency event creator can be the dispatcher who copied the event. The "Use first common event call for call taker and position" setting takes the call taker and call position from the first call on the incident. It applies to the standard export only. The IFCADDEX custom report does not change.

The Data Agent picks the call this way:

  • The first call with FIRST_CALL set to 1.

  • When no call has that flag, the call with the earliest valid CDTS time. Calls with a missing or invalid time sort last. When times are equal, or no call has a valid time, the first call in the file wins.

Call Taker ID and Call Taker Name come from CPERS_EMPLOYEEREF on that call. Call Position comes from CTERM on that call. When the call has no call taker ID, all three fields keep their standard sources. When the call has an ID but no name or position, those fields stay blank.

Each incident still has one call taker. On an incident with several calls, a later 911 call does not get its own call taker. Caller fields and call times keep their standard sources. The setting does not fix incidents that already uploaded.

Troubleshooting Tips

No Files Being Processed

  • Verify the directory path is correct and accessible

  • Confirm the Data Agent account has permissions

  • Increase the “Time back to query” value temporarily to capture older files

Duplicate or Missed Calls

  • Ensure files are not rewritten after initial creation

  • Avoid reusing filenames

Access Errors

  • Validate credentials or gMSA configuration

  • Confirm network connectivity to the file share

Standard Data Fields

These are the standard data fields the Data Agent reads from Hexagon CAD XML files. The Data Agent reads two export formats: the standard export and the IFCADDEX custom report. The tables below show each GovWorx field and the XML element it comes from.

Note: Additional fields are considered enhancement requests.

Standard export: Incident fields

The Data Agent reads one incident from each file.

GovWorx field

XML element

Notes

Incident ID

AEVEN/NUM_1

The Data Agent skips files without NUM_1 or EVENT/EID.

Incident Number

AEVEN/NUM_1

Incident Type

AEVEN/TYCOD, SUB_TYCOD

Uses the EVCOM_LIST/EVCOM values when AEVEN has none. With a subtype, the format is type-subtype.

Agency

AEVEN/AG_ID

Priority

AEVEN/PRIORITY

Incident Date

AEVEN/AD_TS_TIMESTAMP/AD_TS_DATETIME

Location

EVENT/ELOCATION

Latitude

EVENT/LATITUDE

Longitude

EVENT/LONGITUDE

Call Source

COMMON_EVENT_CALL_LIST/COMMON_EVENT_CALL/CALL_SOUR

Caller Number

COMMON_EVENT_CALL_LIST/COMMON_EVENT_CALL/CLRNUM

Caller Name

COMMON_EVENT_CALL_LIST/COMMON_EVENT_CALL/CLNAME

Call Position

AEVEN/CREATE_TERM

Uses CTERM from the earliest EVCOM entry when blank. The first common event call setting uses CTERM from that call.

Call Taker ID

AEVEN/CREATE_PERS_EMPLOYEEREF/CREATE_PERS_USR_ID

Uses CPERS_USR_ID from the earliest EVCOM entry when blank. The first common event call setting uses the call taker of that call.

Call Taker Name

CREATE_PERS_LAST, CREATE_PERS_FIRST

Formatted Last, First. Follows the same fallbacks as Call Taker ID.

Call Received Time

AEVEN/SDTS_TIMESTAMP/SDTS_DATETIME

Uses EVENT/CDTS_TIMESTAMP/CDTS_DATETIME when blank. The earliest CAD note timestamp setting replaces this with the earliest note time.

Call Pickup Time

AEVEN/SDTS_TIMESTAMP/SDTS_DATETIME

Uses EVENT/CDTS_TIMESTAMP/CDTS_DATETIME when blank.

Closed At

EVENT/XDTS_TIMESTAMP/XDTS_DATETIME

Uses AEVEN/XDTS_TIMESTAMP/XDTS_DATETIME when blank.

Standard export: Notes

GovWorx field

XML element

Notes

Note Text

EVCOM_LIST/EVCOM/COMM

Note By

EVCOM/CPERS

Note Time

EVCOM/CDTS_TIMESTAMP/CDTS_DATETIME

Note ID

EVCOM/ID

Standard export: Responders and units

GovWorx field

XML element

Notes

Unit Name

UN_HI_LIST/UN_HI/UNID

Personnel ID

UN_HI_PERSL_LIST/UN_HI_PERSL/EMPID

The first person listed for the unit.

Dispatched By

UN_HI/CPERS

From the entry with UNIT_STATUS DP.

Dispatched At

UN_HI/CDTS_TIMESTAMP/CDTS_DATETIME

The entry with UNIT_STATUS DP.

Enroute At

UN_HI/CDTS_TIMESTAMP/CDTS_DATETIME

The entry with UNIT_STATUS ER.

Arrived At

UN_HI/CDTS_TIMESTAMP/CDTS_DATETIME

The entry with UNIT_STATUS AR.

Cleared At

UN_HI/CDTS_TIMESTAMP/CDTS_DATETIME

The entry with UNIT_STATUS AV, AP, AQ, or AM.

IFCADDEX custom report: Incident fields

The Data Agent reads one incident from each Row in Body/Results. Source names are elements of the last EVENT snapshot in the row, unless the row says otherwise.

GovWorx field

XML element

Notes

Incident ID

Row/num_1

The Data Agent skips rows without num_1 or an EID in any event snapshot.

Incident Number

Row/num_1

Incident Type

TYCOD

Agency

AG_ID

Agency Type

AGENCY_TYPE

Priority

PRIORITY

Disposition

DISPO

Case Number

CASE_NUM

Location

ELOCATION

Latitude

LATITUDE

Longitude

LONGITUDE

Caller Name

CLNAME

Caller Number

CLRNUM

Call Source

CALL_SOUR

Call Position

CTERM

Call Taker ID

EMPID

Call Taker Name

CPERS_NAME

Call Received Time

CDTS_RECIEVE

The earliest CAD note timestamp setting replaces this with the earliest note time.

Call Pickup Time

CDTS_PICKUP

Incident Date

CDTS_RECIEVE

The export has no separate creation time.

Closed At

CDTS_END

Additional Incident Fields

DGROUP

Saved as dispatchGroup when present.

IFCADDEX custom report: Notes

GovWorx field

XML element

Notes

Note Text

COMMENT/COMMENT/COMM

Note By

CPERS

Note Time

CDTS

Note ID

ID

IFCADDEX custom report: Responders and units

GovWorx field

XML element

Notes

Unit Name

UNIT/UNIT/UNID

Personnel ID

CPERS_EMPID

A unit with no assigned person has no Personnel ID.

Dispatched By

CPERS_DISP

This person can differ from the assigned person.

Dispatched At

CDTS_DISP

Enroute At

CDTS_ENRT

Arrived At

CDTS_ATSC

Cleared At

CDTS_CLEAR

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

The local path or UNC share where Hexagon CAD writes XML files when a call is closed. Recognized as a UNC path if it begins with two backslashes (\\).

Use Integrated Security**

Toggle

Determines whether the Data Agent uses a managed service account (gMSA) or explicit credentials to access the directory.

Username**

Text

Required if using explicit credentials. The account must have read access to the directory.

Password**

Password

Required if using explicit credentials.

Time back to query ([days.]hh:mm) (default 01:00, 1 hour)

Text

How far back the Data Agent looks for XML files when scanning the directory. The Data Agent compares this window with the last-write time of each file. Default: 01:00.

Delete files after successfully uploading their data

Toggle

Whether to delete each XML file after it has been successfully processed by the Data Agent.

Only upload incidents that have a close time

Toggle

Toggle will hold incidents that have no usable close time, and incidents that the standard export marks as open. Held incidents do not upload and do not fail the run. A file that holds an incident stays in place even when file deletion is on. The run log lists the number of held incidents and their incident IDs. Default: off. Read Uploading closed incidents only above before you turn this on.

Use first common event call for call taker and position

Toggle

Toggle will take the call taker and call position from the first call on the incident. When off, they come from the agency event creator. Applies to the standard export only. Default: off. See Call taker from the first call above.

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

**: Either Integrated Security or (Username and Password) is required.

Support

For assistance configuring the Hexagon CAD connector or troubleshooting ingestion issues please reach out to us at [email protected] for assistance.

Did this answer your question?