Skip to main content

CAD Connector - Shieldware

GovWorx integration guide for the Shieldware CAD system.

Written by Kevin Biegert

Capabilities

Capabilities

SQL

XML

Connector Capabilities

Read

Yes

Yes

Backfill

No

No

Bidirectional Capabilities

Incident Create

No

No

Incident Update

No

No

Narrative Update

No

No

Overview

SQL Connection

The Data Agent will read data using SQL over an ODBC connection.

The GovWorx Data Agent requires a 64-bit ODBC driver.

XML Export

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

Standard Data Fields

These are the standard data fields the Data Agent reads from Shieldware. The tables below show each GovWorx field and the Shieldware source it comes from.

Note: Additional fields are considered enhancement requests.

SQL: Incident fields

The Data Agent reads calls that closed or filed in the last two hours and that have a dispatch entry in cadlog. Source names are columns of the swcad.call_reporting table unless the row says otherwise.

GovWorx field

Shieldware SQL source

Notes

Incident ID

call_reporting.Call Number

CAD record key.

Incident Number

call_reporting.Call Number

Case Number

call_reporting.Call Number

Incident Type

call_reporting.Actual Call Type

The Use Initial Incident Type setting switches this to Call Type.

Initial Incident Type

call_reporting.Call Type

Caller Number

call_reporting.RP PHONE, RP Work Phone, RP Cell Phone

Joined with commas.

Agency

call_reporting.Police Agency, Fire Agency, Ambulance Agency, Other Agency

Only the services that have a priority. Joined with commas.

Agency Type

Police, Fire, Ambulance, Other

The names of the services that have a priority. Joined with commas.

Incident Date

call_reporting.Date Time Reported

Disposition

call_reporting.Disposition, Fire Disposition, Ambulance Disposition, Other Disposition

Only the services that have a priority. Joined with commas.

Location

call_reporting.Location

Priority

call_reporting.Police Priority, Fire Priority, Ambulance Priority, Other Priority

Only the services that have a priority. Joined with commas.

Call Taker ID

call_reporting.Call Taker

Call Taker Name

call_reporting.Call Taker Desc

Call Source

call_reporting.Call Source

Closed At

cadlog.Date Time Stamp

The log entry with transaction code 203 (filed) or 223 (closed).

SQL: Notes

GovWorx field

Shieldware SQL source

Notes

Note ID

call_reporting_remarks.Remark Number

Note Text

call_reporting_remarks.Remark

Note By

call_reporting_remarks.Updated By

Note Time

call_reporting_remarks.Date Time Updated

SQL: Responders and units

GovWorx field

Shieldware SQL source

Notes

Unit Name

cadlog.Unit Id

The log entry with transaction code 171 (unit dispatched).

Personnel ID

call_reporting_units.Officer 1, Officer 2

Joined with a comma. The Data Agent skips units with no personnel ID and keeps one responder for each personnel ID.

Dispatched By

cadlog.User Id

Dispatched At

call_reporting_units.Date Time Dispatched

Enroute At

call_reporting_units.Time Enroute

Arrived At

call_reporting_units.Time Arrived

Cleared At

call_reporting_units.Time Cleared

XML: Incident fields

File names start with the eight digit call number. The Data Agent reads the newest file for each call number. Source names are elements in the XML file, grouped by section.

GovWorx field

Shieldware XML element

Notes

Incident ID

Other/Call_Number

The Data Agent skips files without it.

Incident Number

Other/Call_Number

Incident Type

Other/Actual_Call_Type

Initial Incident Type

Other/Starting_Call_Type

Caller Number

Other/RP_Cell_Phone

Caller Name

Other/Reporting_Party

Agency

Other/Ambulance_Agency, Fire_Agency, Other_Agency, Police_Agency

Each value that is not empty, joined with commas.

Agency Type

Fixed value

Always Ambulance,Fire,Other,Police.

Incident Date

Times/Date_Time_Queued

Disposition

Other/Ambulance_Disposition, Fire_Disposition, Other_Disposition, Police_Disposition

Each value that is not empty, joined with commas.

Location

Location/Location_Full

Priority

Other/Ambulance_Priority, Fire_Priority, Other_Priority, Police_Priority

Each value that is not empty, joined with commas.

Latitude

Location/Latitude

Longitude

Location/Longitude

Call Position

Other/Workstation_Number

Uses Call_Source when empty and the Use Call Source for Position setting is on.

Call Taker ID

Other/Call_Taker_Id

Call Taker Name

Other/Call_Taker_Name

Call Source

Other/Call_Source

Call Received Time

Times/Date_Time_Queued

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

Call Pickup Time

Times/Date_Time_Queued

Closed At

Times/Date_Time_Overall_Call_Closed

Response Area

Other/Ambulance_District, Fire_District, Other_District, Police_District

Each value that is not empty, joined with commas.

XML: Notes

GovWorx field

Shieldware XML element

Notes

Note ID

Remarks/Remark/Remark_Number

Note Text

Remarks/Remark/Call_Remark

Note By

Remarks/Remark/Entered_By

Note Time

Remarks/Remark/Remark_Date_Time

XML: Responders and units

GovWorx field

Shieldware XML element

Notes

Unit Name

Units/Unit/Unit_Id

Personnel ID

Units/Unit/Unit_Id

The unit ID.

Dispatched At

Units/Unit/DateTime_Dispatched

Enroute At

Units/Unit/DateTime_Enroute

Arrived At

Units/Unit/DateTime_Arrived

Cleared At

Units/Unit/DateTime_Cleared

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.

SQL Connection

*: Required

**: Either DSN or (Database Server and Database Name) is required.

Setting

Type

Explanation

UID*

Text

User ID (Connection string keyword "UID")

Password*

Password

Password (Connection string keyword "PWD")

DSN**

Text

Data Source Name. The Data Agent uses the DSN when you enter one.

Database Server**

Text

Host name or IP address of the database server. Used when you do not enter a DSN.

Database Name**

Text

Name of the database to read from. Used when you do not enter a DSN.

ODBC Driver (Default: MySQL ODBC 3.51 Driver)

Text

Name of the ODBC driver. Used when you do not enter a DSN.

Connection Option (Default: 3)

Text

The ODBC connection option. Used when you do not enter a DSN.

Use Initial Incident Type Instead of Final

Toggle

Whether CommsCoach should report incidents back using the initial or final type from Shieldware. Toggle on to use the initial type.

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.

XML Export

*: Required

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 ("\\").

Use Integrated Security

Toggle

Whether to use gMSA or explicit credentials

Username

Text

Provide if using explicit credentials

Password

Password

Provide if using explicit credentials

Delete files once uploaded

Toggle

Toggle will delete the XML files for a call after the Data Agent uploads its data successfully.

Use Call Source for Position

Toggle

Toggle will use the Call_Source element as the call position when the file has no Workstation_Number element.

Time back to query

Text

Look for files changed within this time back. Format: [days.]hh:mm. Default: 01:00 (1 hour).

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.

Did this answer your question?

Related Articles