Capabilities

Capabilities	Versaterm	Versaterm Informix	Versaterm API
Connector Capabilities
Read	Yes	Yes	No
Backfill	Yes	No	No
Bidirectional Capabilities
Incident Create	No	No	Coming soon
Incident Update	No	No	Coming soon
Narrative Update	No	No	Coming soon

The Versaterm API connection does not read incident data. Incident data comes from the Data Agent connectors. Write-back through the API connection (create incident, update incident and add narrative) is coming soon. For details on bidirectional capabilities, see Bidirectional CAD Integrations.

Overview

The Data Agent will read from the Versaterm database. In views mode, it reads three view definitions: govworx_calls, govworx_units and govworx_remarks. In tables mode, it reads the CAD tables directly. To do this we need a user to connect to the database.

We will send the view definitions to be created separately

The Versaterm Informix connector reads from an Informix database through an ODBC data source (DSN) on the Data Agent server. It reads the CAD tables and has no views mode. It reads incidents closed in the last 30 minutes. It has no backfill option.

Versaterm API connection

Versaterm also connects through the GovWorx Connections Platform. This is an API integration. It does not use the GovWorx Data Agent. Nothing is installed on your network.

Versaterm sends GovWorx a message when an interaction starts, when it is linked to a CAD incident, and when it is aborted. GovWorx sends updates back to a listener that Versaterm hosts. These updates are narrative comments, incident type recommendations, dispatch recommendations and the completed transcript. GovWorx recommends units and does not dispatch them.

For the endpoint, authentication and message format, see the GovWorx developer documentation.

Standard Data Fields

These are the standard data fields the Data Agent reads from Versaterm. The tables below show each GovWorx field and the Versaterm column it comes from. The Versaterm connector and the Versaterm Informix connector read the same sources. The Notes column marks each difference.

Note: Additional fields are considered enhancement requests.

Incident fields

GovWorx field	Versaterm source	Notes
Incident ID	`cc_data.rin, cl_data.rin`	Police records come from cc_data. Fire and EMS records come from cl_data.
Incident Number	`jurisdiction, occ_year, occ_num`	Joined as jurisdiction, year, a hyphen and the number.
Incident Type	`cc_data.case_type, cl_data.call_type`
Initial Incident Type	`cc_data.case_type, cl_data.call_type`	Tables mode only. Same value as Incident Type.
Caller Number	`comp_area_code, comp_telephone`	Joined with a hyphen.
Caller Name	`comp_first, comp_middle, comp_name`	Joined with spaces.
Agency	`jurisdiction`	Views mode uses the first two characters of zone, then municipality, then jurisdiction. The first one with a value wins.
Agency Type	Fixed value LAW	Tables mode and Informix, police records only.
Incident Date	`cc_data.occ_date, cl_data.occ_time`
Disposition	`cleared_by.translation`	Matches cleared_by to the cleared_by code of the record.
Location	`address, municipality`	Joined with a comma when municipality has a value.
Location Name	`place_name`	Views mode only.
Apartment	`apt_no`	Views mode only.
Priority	`priority`	Views mode only.
Latitude	`y_coordinate`
Longitude	`x_coordinate`
Call Position	`cc_summary.call_taker_desk, cl_data.desk_id`
Call Taker ID	`call_taker_id`
Call Taker Name	`officer_number.translation`	Matches officer_number to call_taker_id and call_taker_jurs.
Call Source	`how_received`	Views mode and Informix use this column. Tables mode sets EMERGENCY_CALL.
Call Received Time	`cc_data.occ_date, cl_data.occ_time`	The earliest CAD note timestamp setting replaces this with the earliest note time.
Closed At	`cc_summary.clear_time, cl_data.clear_time`	The Data Agent reads closed incidents by clear time.
Dispatch Queue At	`orig_time_queued`	Informix and views mode. Tables mode reads cc_data.time_queued for police records only.
Related Incident	`cc_to_cc.complaint_rin1, cl_to_cl.call_rin1`	Views mode only.
Additional Context	`e911_data, e911_linkage, change_log`	Views mode only. Lists the E911 location records, the incident type changes and the location changes.
Additional incident fields	`AdditionalIncidentFieldsJson`	Views mode only. A JSON object of customer-specific fields in the view.

Notes

GovWorx field	Versaterm source	Notes
Note ID	`cc_remarks.rin, cl_remarks.rin`
Note Text	`remarks`	The Data Agent skips empty remarks. The view also skips police remarks that start with ! or contain @ or ! after a space.
Note By	`desk_id`
Note Time	`cc_remarks.last_update, cl_remarks.last_update_date`

Responders and units

GovWorx field	Versaterm source	Notes
Unit Name	`dc_data.unit_id, fdp_data.app_id`	Police units come from dc_data. Fire and EMS units come from fdp_data.
Personnel ID	`dc_data.unit_id, fdp_data.app_id`	Same value as Unit Name.
Dispatched By	`officer_number.translation, dispatcher_id`	Tables mode and Informix join the name and the ID with a hyphen. Views mode uses dispatcher_id.
Dispatched At	`dispatch_time`
Enroute At	`enroute_time`
Arrived At	`at_scene_time`
Cleared At	`inservice_time`

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. The Versaterm API connection has no Data Agent settings.

Versaterm

Setting	Type	Explanation
`Host*`	Text	Host of the Versaterm database
`Username*`	Text	Database user
`Password*`	Password	Database password
`Database name*`	Text	Database Schema to read from
`Use views instead of tables`	Toggle	Toggle will read from the views govworx_calls, govworx_units and govworx_remarks in place of the CAD tables.
`Views mode: first-run lookback in minutes, no cursor (default: 20)`	Number	How far back the first run looks for closed incidents. Default: 20.
`Views mode: maximum lookback in hours (default: 8)`	Number	Caps how far back a stale cursor can reach. Default: 8.
`Backfill a fixed date range instead of normal polling (works in both views and tables mode; normal polling is suspended while this is on)`	Toggle	Toggle will query a fixed date range, for backfilling historical data. Normal polling stops while this is on.
`Backfill range start (yyyy-MM-dd HH:mm, CAD-local)`	Text	Beginning time of the fixed range.
`Backfill range end, inclusive of this exact minute (yyyy-MM-dd HH:mm, CAD-local; use the next day 00:00 to cover through midnight)`	Text	End time of the fixed range. Use 00:00 of the next day to cover through midnight.
`Split the backfill range into chunks no longer than (hh:mm, default 01:00)`	Text	Splits the fixed range into chunks of this length. Default: 01:00.
`Agency Types to include (comma separated)`	Text	Comma separated list of jurisdiction codes to include. Applies in tables mode.
`Tables: Exclude fire and EMS records`	Toggle	Toggle will read police records only. Applies in tables mode.
`PD/Law Enforcement (cc_data table): cc_relation values to include (comma separated, e.g. null,+,M,S,R,F or leave empty for defaults)`	Text	The cc_relation values to include. Blank uses null,+. Applies in tables mode.
`Fire/EMS (cl_data table): cl_relation values to include (comma separated, e.g. null,+,M,S,R,F,X or leave empty for defaults)`	Text	The cl_relation values to include. Blank uses null,+. Applies in tables mode.
`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

Versaterm Informix

Setting	Type	Explanation
`UID*`	Text	Database user
`Password*`	Password	Database password
`DSN*`	Text	Name of the ODBC data source on the Data Agent server that points to the Informix database.
`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.