Central Square

Information

NOTE: This is a Business Intelligence Service Integration which means the "Business Intelligence Service" module must be installed for it to work.

Overview

The Central Square integration listens for incoming HTTP POST requests from Central Square servers, converts them to SureView alarms and forwards them through the Business Intelligence Service.

Prerequisites

In order to use the Central Square integration, you must have the "Business Intelligence Service" package installed (version 1.4.26081.0 or newer) . Please see the "Business Intelligence Service" article for more details.

Installation

This integration can be installed using the sureview package installer. Firstly ensure the required prerequisites have been met. Then Using Setup, install the latest version of the "Central Square" module.

Once the package has been successfully installed this can be confirmed by ensuring DevCentralSquareSoapIntegration.dll has been placed in the Immix Cloud\SVBusinessIntelligence directory.

Required Ports

Central Square soap service Decoder

The soap service requires the message body to be the same as below

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<XmlMessage xmlns="http://tempuri.org/">
**INSERT XML HERE**
</XmlMessage>
</s:Body>
</s:Envelope>

If a string xml needs to be sent then encase the message as shown below

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<XmlMessage xmlns="http://tempuri.org/">
<![CDATA[
**INSERT XML HERE**
]]> 
</XmlMessage>
</s:Body>
</s:Envelope>

The Central Square soap service decoder is set up to parse XML messages to DOC objects. The XML needs to be inserted into the message above.

By default, the Address is used to identify the location. If no Address (property) has been provided then the system creates an address from the other Address, City, and state information. If longitude/latitude are to be provided then the BIS appsettings.json needs to be changed to

"CentralSquare_Settings": {
"UseLatLongAsPrimarySearch": true
}

Alarms

Once the integration is installed it is loaded by the Business Intelligence Service and will start listening on the ports stated above for incoming HTTP POST requests which contain a SOAP body.

The expected URL root path is:

http(s)://<host>/BusinessIntelligence/CentralSquare

Where "host" is the hostname of the SureView server running the Business Intelligence Service.

Device also needs to be set up for Central Square in order for the alarm to be activated.

The distanceConfiguration table also needs to be updated for the correct group with an appropriate radius in order for the alarm to trigger

Custom MetaData Fields

Create a CentralSquareConfiguration.json inside the SVBusinessIntelligence folder.
Add a JSON object containing the fields that should be displayed, and the display name of that field. Only fields listed in the CentralSquareConfiguration.json will be included.
For example

{
"IncidentID": "Incident ID",
"Station": "Station",
"MasterIncidentNumber": "Master Incident Number",
"ResponseDate": "Response Date",
"Battalion": "Precinct"
}

The left-hand value (the key) needs to exactly match the name of the field from the CAD XML, however, it is not case sensitive.

The right-hand value is the display label for the field, this must be included even if the display label is the same as the field name however, the value can be changed and does not need to match the field name.

When no CentralSquareConfiguration.json is present the default field values will be used.
If there is an error processing the CentralSquareConfiguration.json the default field values will be used.
Error logging has been added to indicate if custom fields or default are in use.
Note: CentralSquareConfiguration.json values are cached for 10 minutes. restarting the service resets the cache immediately.