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. CIS IMARS writes one XML file for each incident. The Data Agent reads the *.xml files in the top level of the directory. It does not read subfolders.

The Data Agent reads files whose file time falls in the time back window. The default window is the last 1 hour. When the same incident appears in more than one file, the Data Agent keeps the newest file.

The Data Agent skips files for deleted incidents (processType D), files with no Event element, and files with no incident number.

Standard Data Fields

These are the standard data fields the Data Agent reads from CIS IMARS XML files. The tables below show each GovWorx field and the source it comes from. Source names are elements inside the Event element, or attributes where the row says so.

Note: Additional fields are considered enhancement requests.

Incident fields

GovWorx field	CIS IMARS source	Notes
Incident ID	`RECORD_ID`	Uses SUBAGENCY code and INCIDENT_NUMBER, joined with a hyphen, when RECORD_ID is empty.
Incident Number	`INCIDENT_NUMBER`	The Data Agent skips a file with no incident number.
Case Number	`CASE_NUMBER`
Agency	`SUBAGENCY (code attribute)`
Agency Type	`SERVICE_TYPE`	Display text of the element. Stays empty when SERVICE_TYPE has no text.
Incident Type	`Activities/Activity (code attribute)`	Uses the Activity marked primary, or the first Activity. Stays empty when that Activity has no code. Connector version 1.0.5 and later use this mapping. Incidents read before the upgrade keep their earlier values.
Priority	`PRIORITY`	Display text of the element.
Disposition	`Dispositions/Disposition`	Uses the Disposition marked primary, or the first Disposition.
Incident Date	`REPORT_DATE`	Local time at the agency.
Call Received Time	`REPORT_DATE`	Local time at the agency. The earliest CAD note timestamp setting replaces this with the earliest note time.
Closed At	`COMPLETED_DATE`	Local time at the agency.
Call Taker ID	`CALL_TAKER (code attribute)`	Uses the badgeNbr attribute when code is empty. A badgeNbr of n/a is ignored.
Call Taker Name	`CALL_TAKER`
Call Source	`INTAKE_METHOD`
Caller Name	`Persons/Person (role COMPLAINANT)`	FNAME and LNAME, joined with a space.
Caller Number	`Persons/Person/Locations/Location/Phones/Phone`	AREA_CODE, PREFIX and SUFFIX, joined without spaces.
Location	`Location/Address`	Street number, street name, CITY, STATE code and ZIP, joined with commas.
Location Name	`Location/COMMON_PLACE_NAME`
Street Number	`Location/Address/STREET_NUMBER`
Street Name	`Location/Address (STREET_PREFIX_DIR, STREET_NAME, STREET_TYPE)`	The prefix direction and street type use their code attributes.
Apartment	`Location/Address/SUB_NUMBER`
City	`Location/Address/CITY`
State	`Location/Address/STATE (code attribute)`
Zip	`Location/Address/ZIP`
County	`Location/Address/COUNTY`
Additional Incident Fields	`Code attributes and other elements`	Holds priorityCode, serviceTypeCode, dispositionCode, activityCode, activityType, blotter, beat, zone, route and referenceCaseNumbers. The Data Agent adds each one only when it has a value.

Notes

GovWorx field	CIS IMARS source	Notes
Note ID	`IncidentLog/LogEntry (ENTRY_DATE, ENTRY_BY)`	IMARS sends no note ID. The Data Agent joins the entry date and the author code with a vertical bar.
Note Text	`IncidentLog/LogEntry/ENTRY_TEXT`
Note By	`IncidentLog/LogEntry/ENTRY_BY (code attribute)`
Note Time	`IncidentLog/LogEntry/ENTRY_DATE`	Local time at the agency.

Responders and units

GovWorx field	CIS IMARS source	Notes
Responder ID	`UnitStatusHistory/StatusChange/UNIT (code attribute)`	One responder for each unit code.
Unit Name	`UnitStatusHistory/StatusChange/UNIT (code attribute)`
Personnel ID	`UnitStatusHistory/StatusChange/Officers/Officer`	Uses the primary Officer, or the first one. Takes the code attribute, or badgeNbr when code is empty.
Dispatched At	`STATUS_DATE`	From the status change with STATUS code W.
Dispatched By	`CHANGED_BY (code attribute)`	From the status change with STATUS code W.
Enroute At	`STATUS_DATE`	From the status change with STATUS code 2.
Arrived At	`STATUS_DATE`	From the status change with STATUS code 3.
Cleared At	`STATUS_DATE`	From the status change with STATUS code 1.

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	Local path or UNC share path that holds the XML files. A path that starts with two backslashes is a UNC path.
`Use Integrated Security`	Toggle	Toggle will use the account that runs the Data Agent service to open a UNC share. Leave it off to use the username and password.
`Username (when not using integrated security)`	Text	Account that opens the UNC share.
`Password (when not using integrated security)`	Password	Password for the account that opens the UNC share.
`Time back to query ([days.]hh:mm) (default 01:00, 1 hour)`	Text	How far back the Data Agent looks at the file time. Files older than this are skipped. Default: 01:00, which is 1 hour.
`File Timestamp Mode`	Text	Which file time the Data Agent compares to the time back window. Options: Last modified time (default), File creation time, or Newest of creation or modified time.
`Delete files after successfully uploading their data`	Toggle	Toggle will delete each XML file after the Data Agent uploads its incident.
`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 - CIS IMARS XML