Omnitronics AGS. Advanced GPS Service. User Manual

Transcription

1 Omnitronics AGS Advanced GPS Service User Manual

2 Omnitronics AGS Advanced GPS Service User Manual Omnitronics Pty Ltd. All rights reserved. (ABN: ) Product Notice This guide describes features that are common to most installations as well as optional features available separately. Some features may not be available at your installation. Images in this manual are for illustration purposes only. Omnitronics AGS was formerly known as RediTALK AGS. No part of the contents of this publication may be reproduced or transmitted in any form or by any means without the prior written consent of Omnitronics. Information contained in this document is provided solely to enable use of Omnitronics products. Omnitronics assumes no liability whatsoever for neither technical or editorial errors that may appear in this document nor does it make a commitment to update the information contained herein. Omnitronics retains the right to make changes to this information at any time without notice. Trademarks DX-Altus, Alto, RediTALK-Flex, and Omnitronics Advanced GPS Service (AGS) are trademarks of Omnitronics Pty Ltd. Technical Support If you require additional information or assistance with installation or configuration of this product, please contact our technical support at the appropriate contact details shown below. When contacting Omnitronics for support, please have your Omnitronics product serial number, system hardware, and system software versions available. Australia (Head Office): Omnitronics Pty Ltd 27 Sarich Court Osborne Park, WA 6017 Australia P: F: support@omnitronics.com.au Australia (East Coast): Omnitronics Pty Ltd 301 Coronation Drive Milton, QLD 4064 Australia P: F: support@omnitronics.com.au North America (USA): Omnitronics, Inc S. Harbor City Blvd, Ste #328 Melbourne, FL USA P: +1 (904) F: +1 (904) servicedesk@omnitronicsworld.com Documentation Feedback Omnitronics welcomes your comments and suggestions for improving this manual. You can your comments and suggestions to documentation@omnitronics.com.au. Please include the Omnitronics product name and version with your correspondence. Omnitronics will carefully consider all feedback for future improvements to Omnitronics documentation or software. Date: November 2018 Document Number: MNL ii

3 Document Revision History Issue Date Description /2014 Original publication /2014 Updated Requirements /2015 Updated Transferring the License. Added Reinstalling the Product License. Added Licensing Problems /2017 Updated Overview. Updated Requirements. Updated Installing Omnitronics AGS. Updated Understanding the Configuration Interface. Updated Viewing the System Status". Added Configuring the System Settings. Updated Location Server". Updated Devices (DRG). Added Profiles. Added Console Users. Added Event Severities. Added Application Settings. Updated Backing up and Restoring the Configuration /2017 Updated "Resolving Licensing Issues". Updated "Viewing the System Status". Updated System Version Information. Updated "Application Configuration". Added "Locally Persisted Events". Updated Application /2018 Added Restarting Omnitronics AGS. Updated Transferring the License. Updated Reinstalling Software Licenses. Added Replacement Software License due to Hardware Failure. Updated Terminology. Updated Application Settings. Inserted XML Protocol Specification /2018 Updated "Transferring the License". Updated Introduction. Updated About Omnitronics AGS. Please report any errors or omissions in this document to Omnitronics so that such errors or omissions may be corrected in later issues (see Documentation Feedback on page ii). iii

4

5 Contents Introduction 1 About Omnitronics AGS... 1 Features... 2 Requirements... 2 Related Documentation... 3 Terminology... 3 Getting Started 5 Installing and Uninstalling Omnitronics AGS... 5 Restarting Omnitronics AGS Product Licensing and Activation Activating the Product Online Activating the Product Offline Offline Activation by Omnitronics Support Activation after Expiry of Trial Period Online Activation Offline Activation Transferring the Product License Reinstalling the Product License Replacement Product Software License due to Hardware Failure Resolving Licensing Issues Configuration 27 Understanding the Configuration Interface Logging in Viewing the System Status System Version Information Application Configuration Location Server Status v

6 Event Status Device Status Unit Information Locally Persisted Events Configuring the System Settings Location Server Settings Devices (DRG) Settings Profile Settings Profile Properties Geofence Events Adding a New Profile Renaming a Profile Deleting a Profile Resetting Events to Defaults Console User Settings Adding a New Console User Renaming a Console User Deleting a Console User Event Severity Settings Application Settings Changing the Password Backing up & Restoring the Configuration Backing up the Configuration to a File Restoring the Configuration from a File Product Activation Exiting the Configuration Interface XML Protocol Specification 49 Outgoing Updates XML Data Structure Sample XML Data XML File Naming Convention XML File Transfer XML File Update Rate vi Contents

7 Process Flow Incoming Updates XML Data Structure Sample XML Data Event Contract Definition Process Flow Event Callback Contract Definitions Contract ID Contract Type Pair ID Field ID Field Type Event ID AGS Database Schema Notes 61 vii

8

9 Introduction This chapter includes the following sections: About Omnitronics AGS Features on page 2 Requirements on page 2 Related Documentation on page 3 Terminology on page 3 About Omnitronics AGS Omnitronics Advanced GPS Service is a Windows service that runs in the background on a dedicated server computer (Omnitronics recommends that you install it onto a dedicated server for best performance). This service acquires GPS location data from radios in the field via DRGs. It then aggregates the location data from multiple radios and passes the information onto a third-party GPS tracking service provider. Figure 1 illustrates the system architecture of AGS and shows an example of several DRG100 digital-radio gateways interfacing to two different types of radio with GPS. The interface between Omnitronics DRGs and radio systems can be over IP or through donor radios. Figure 1. Omnitronics AGS system architecture Omnitronics AGS User Manual 1

10 Omnitronics DRG (Digital Radio Gateway) products also provide location information to Omnitronics consoles, which then use this for basic GPS functionality. Omnitronics AGS will also forward geofence events received from a connected ALS Server to all connected RediTALK-Flex consoles and DX-Altus systems. Omnitronics Advanced GPS Service is an advanced GPS location monitoring service that acts as a GPS information gateway for Omnitronics DRG (Digital Radio Gateway) products and Omnitronics radio-dispatch consoles such RediTALK-Flex and Alto, and Advanced Location Services (ALS). Omnitronics Advanced GPS Service gathers GPS location data from remote radios via digital-radio gateways (DRG) and passes the data onto either a third-party location service provider for monitoring of remote devices, or onto the Omnitronics ALS Server for permanent storage, geofence events, alerts, and to a SQLite or Microsoft SQL Server (SQL Server Express) database. Geofence events generated from Omnitronics ALS Server are then passed back through the Advanced GPS Service to connected Omnitronics dispatch consoles. Omnitronics Advanced GPS Service (AGS) is available separately as an optional licensed add-on for RediTALK-Flex VoIP Radio Dispatch Console and Alto Dispatch Console products, as well as Advanced Location Services (ALS). Features Omnitronics AGS is an advanced GPS location service that provides an intuitive and easy-to-use configuration interface accessible using a web browser. Omnitronics AGS provides the following features: Centralised GPS data collection Collects GPS location data from multiple DRG devices and collates it into a centralised database. Collects call information Collects digital-radio call information (Individual, Group Call and All Call) from multiple DRG devices, and links it to the location information. Updates location server Periodically updates a specified location server with all GPS location and call information. Requirements Omnitronics AGS requires at least the Microsoft.NET Framework version 4.0 and the Microsoft C Redistributable to be installed on the computer for it to function correctly. When you install AGS, it will automatically download the installer(s) for you, as required. AGS is designed to run on a dedicated server computer under Microsoft Windows operating system (see below) with the latest updates from Microsoft Updates installed as a minimum requirement. 2 Introduction

11 Minimum Requirements CPU: Intel Dual Core i5 2.5GHz OS: Microsoft Windows (32-bit or 64-bit) with latest updates: Windows 7/8/8.1/10 Windows Server 2008 R2, Windows MultiPoint Server, Windows Home Server 2011 (home server operating system), Windows Server 2012 and Windows Server 2012 R2 Memory: 4GB RAM HDD space: 320GB hard disk (68MB required for AGS) Ethernet port: 10/100 Mbps Video card: GeForce 8800GS 512MB or Intel HD4000 (onboard video or equivalent) with Microsoft DirectX 11 USB: 4 x USB 2.0 ports (touchscreen, computer keyboard and mouse as required) Standard keyboard and mouse DVD-ROM drive (USB drive can be used to install software) Related Documentation In addition to this manual, you may find the following documentation helpful this documentation is usually supplied with the original system: RediTALK-Flex VoIP Radio Dispatch Console User Manual (MNL-00196) Alto Dispatch Console User Manual (MNL-00096) Terminology The following terminology is used throughout this Manual. AGS Console Donor Radio HTTP Refers to the Omnitronics Advanced GPS Service a Windows service running on a dedicated server acting as a gateway between Omnitronics console products and Omnitronics ALS or third-party providers of GPS tracking services. Refers to the Omnitronics Radio Dispatch Consoles such as RediTALK-Flex VoIP Radio Dispatch Console and DX-Altus Alto Dispatch Console. Refers to a transceiver acting as an interface between a console system (RediTALK-Flex or DX-Altus/Alto) and a radio network. The donor radio will typically be a mobile or portable radio. The audio interface is typically analog and the data interface is typically serial (RS232 or USB). Hypertext Transfer Protocol: the standardized protocol for transferring hypertext documents on the World Wide Web. Omnitronics AGS User Manual 3

12 IP Subscriber XML XSD Internet Protocol: a communications protocol for computers connected to a network. Refers to a portable device that reports its GPS location. Extensible Markup Language is a markup that defines a set of rules for encoding documents in a format that is both humanreadable and machine-readable. XML Schema Definition specifies how to formally describe the elements in an Extensible Markup Language (XML) document. It can be used by programmers to verify the content of elements in a document, and to check each element adheres to the description of the element it is placed in. 4 Introduction

13 Getting Started This chapter provides details about how to install and activate the Advanced GPS Service, and includes the following sections: Installing and Uninstalling Omnitronics AGS on page 5 Product Licensing and Activation on page 12 Installing and Uninstalling Omnitronics AGS You can install Omnitronics Advanced GPS Service (AGS) on a single computer running a compatible operating system (see procedure below). If you need to uninstall Omnitronics AGS, you can do so from the Windows Control Panel (see To uninstall the Omnitronics AGS product procedure on page 10). Upgrading to a newer version of AGS When upgrading to a newer version of AGS, Windows Firewall might block the service and prevent Omnitronics Dispatch Consoles from communicating with it (the consoles may stop receiving alerts for ALS systems). To resolve this issue, after updating AGS, you should add the AGS Service to the list of allowed programs in Windows Firewall (even if it is already listed as an exception): C:\Program Files (x86)\omnitronics\advanced GPS Service\GpsService.exe During the installation process, you may be prompted to install the C++ Redistributable Package, as this needs to be downloaded and installed first. The Omnitronics AGS Setup Wizard will automatically do this for you. However, you can also download it directly from the following site if you wish: 32-bit Windows: 64-bit Windows: Note: You must have administrator permissions to install AGS and you must install it on a local drive: it cannot be installed on a network drive. Omnitronics AGS User Manual 5

14 To install Omnitronics Advanced GPS Service 1 Insert the Omnitronics Advanced GPS Service CD/DVD or USB stick into your computer. The installation Setup Wizard should automatically start and show the Welcome to the Advanced AGS Service Setup Wizard screen. If the installation does not automatically start, run drive:\autorun, where drive is the drive letter of your CD/DVD/USB drive. 2 Tap Next to display the License Agreement. 3 Read and accept the license agreement by selecting I accept the license agreement. 4 Tap Next to display the Select Destination Location screen. 6 Getting Started

15 5 (Optional) At the Select Destination Location screen, click Browse if you want to change the default location for the Omnitronics AGS program files, and then select the folder from the Browse For Folder window. The Setup Wizard will install the Omnitronics AGS program files into the C:\Program Files (x86)\omnitronics\advanced GPS Service folder by default. It requires at least 36MB of available disk space. 6 Tap Next to display the Select Additional Tasks screen. 7 At the Select Additional Tasks screen, select Install Sentinel LDK Runtime Environment. 8 Tap Next to display the Ready to Install screen. 9 Tap Install to commence the installation. If the Visual C Redistributable package is already installed on your computer, the Setup Wizard will display the progress of the installation as it installs Omnitronics AGS on your computer. Omnitronics AGS User Manual 7

16 Otherwise, the Setup Wizard will prompt you to install the Visual C Redistributable package. 10 If you are prompted, click Yes to install the Visual C Redistributable package; otherwise skip to step 13. The Welcome screen is displayed. 11 At the Welcome screen, select the option I have read and accept the license terms, and then click Install. 8 Getting Started

17 Once the Visual C Redistributable package is installed, the Installation Is Complete screen is displayed. 12 Tap Finish. 13 Tap Finish to complete the installation. Omnitronics AGS should now be installed on your computer and running in the background as a Windows service. You can check this in the Windows Services you should see a service name of Omnitronics Advanced GPS Service with a status of Running. Omnitronics AGS User Manual 9

18 To uninstall the Omnitronics AGS product 1 On the Start menu, click Control Panel, and then click Programs and Features. The Programs and Features dialog appears. 2 In the program list, locate and select Advanced GPS Service, and then click Uninstall. The Uninstall confirmation message appears. 3 Tap Yes to uninstall Omnitronics AGS. Windows commences uninstalling Omnitronics AGS and when it is completely uninstalled, the following message is displayed. 4 Tap OK, and then close the Programs and Features dialog. 10 Getting Started

19 Restarting Omnitronics AGS Usually, you will not need to restart the Omnitronics Advanced GPS service (AGS). However, you may need to restart the service from time to time especially after you make changes to the application settings, such as the reverse geocoding or changing the port number (see Application Settings on page 40). To restart Omnitronics Advanced GPS service 1 Press the Win + R keys on the keyboard to open the Run dialog, and then type services.msc in the Open text box. 2 Click OK to open the Services dialog, and select Omnitronics Advanced GPS Service in the list of services. 3 On the toolbar, click the button to restart the service. The Omnitronics Advanced GPS Service should restart after several seconds. Omnitronics AGS User Manual 11

20 Product Licensing and Activation Omnitronics AGS requires a product license in order to run. Once you purchase a license, and Omnitronics processes your order, a product activation key will be generated and sent in an to the address you provided when you purchased the product. You can then use this key to activate your product as described in the following sections. If you do not have a product license, you can continue to run the product in trial mode for a period of fourteen days from the date of installation. After this period, you will no longer be able to run the product unless you purchase a license from Omnitronics. If after 90 days from the date of installation you still have not activated the product, you will no longer be able to run Omnitronics AGS (even for the purpose of activating the product) and you will need to contact Omnitronics support for assistance. Activating the Product Online To use this method of activation, the computer on which you want to activate Omnitronics AGS must be online (access to the Internet). If the computer is not online, you can use the method described in the section (see Activating the Product Offline on page 12). You can continue to run the product in trial mode for a period of fourteen days from the date of installation. During this trial period, you can activate the product at any time once you receive your product activation key. If you have already received your product activation key from Omnitronics, you can activate your product online during the trial period from the Utilities Activate License page (see Product Activation on page 46). Activating the Product Offline If the computer on which you want to activate Omnitronics AGS is not connected to the Internet, but you have access to another computer with Internet access, you can still activate the product by connecting with the Omnitronics Product Activation Server using the offline-activation method described below. If your fourteen-day trial period has already expired, you cannot use this procedure to activate Omnitronics AGS. You can, however, still activate Omnitronics AGS by using one of the procedures described later in this chapter (see Activation after Expiry of Trial Period on page 16). 12 Getting Started

21 To activate the product offline 1 Run the Remote Update System (RUS) tool located in the installation folder. 2 On the Collect Status Information tab, select Installation of new protection key. 3 Click Collect Information. This will build the host-fingerprint file (C2V) required for later steps. 4 Click Save to save the host-fingerprint file to a portable storage device (such as a USB drive). 5 On a computer with Internet access, run your browser and navigate to the Omnitronics Customer Portal Login site located at the following address: This displays the Product Key Login page. 6 In the Product Key text box, copy and paste the product key as purchased from Omnitronics. 7 Click Login. Once you have successfully logged in, the following page appears. Omnitronics AGS User Manual 13

22 8 Click Offline Activation. This displays the Generate License form shown below. 9 Click Upload C2V button. 10 In the Upload dialog, select the host-fingerprint file from step Click Generate to generate a V2C license file. Note: The V2C license file is also attached to an that will be automatically sent to the address specified in the customer details shown on the form. Once the V2C file is generated, the following screen is displayed. 12 Click the Download V2C File link to save the license file to a portable storage device (such as a USB drive). This license file will be required on the original offline computer. Note: This file is the same as the file attached in the auto-generated in step Getting Started

23 13 On the offline computer (on which activation is required), run the RUS tool located in the application installation folder. 14 Click the Apply License File tab. 15 Click Update File button. 16 In the Update dialog, select the V2C file on the portable storage device from step Click Apply Update to conclude the activation. Your Omnitronics AGS product should now be activated on the offline computer. Offline Activation by Omnitronics Support If the computer on which you want to activate Omnitronics AGS is not on the Internet, and you don t have access to another computer, you can get Omnitronics to activate your product remotely by using the following method. If your fourteen-day trial period has already expired, you cannot use this procedure to activate Omnitronics AGS. You can use one of procedures described later in this chapter (see Activation after Expiry of Trial Period on page 16). To activate the product remotely by Omnitronics 1 Run the Remote Update System (RUS) tool located in the application folder. 2 On the Collect Status Information tab, select Installation of new protection key. 3 Click Collect Information. This will build the host-fingerprint file (C2V) required for later steps. 4 Click Save to save the host-fingerprint file to a portable storage device (such as a USB drive). You will need to this file to Omnitronics when you have Internet access. 5 On a computer with Internet access, the host-fingerprint file to Omnitronics Technical Support (see contact details on inside front cover). Omnitronics Technical Support will generate a license key and a V2C license certificate in a V2C license file for you. This file will then be ed to you. 6 When you receive the license file, copy this to the original offline computer using your portable storage device. 7 On the offline computer (on which activation is required), run the RUS tool located in the application installation folder. 8 Click the Apply License File tab. 9 Click Update File button. 10 In the Update dialog, select the V2C file on the portable storage device. 11 Click Apply Update to conclude the activation. Omnitronics AGS should now be activated on the offline computer. Omnitronics AGS User Manual 15

24 Activation after Expiry of Trial Period Once the fourteen-day trial period has expired, you cannot use any of the procedures above to activate your Omnitronics AGS installation. In this case, you will need to connect with the Omnitronics Product Activation Server over the Internet using one of the methods described below. AGS computer online Other computer online What to do Use the procedure for Online Activation below. Use the procedure for Offline Activation (see Offline Activation on page 17). Follow steps (7) to (11) in the procedure for Offline Activation (see Offline Activation on page 17) to create the C2V host-fingerprint file (use the RUS tool located in the AGS installation folder). You must then send that fingerprint file to Omnitronics Support using a USB Flash drive (or similar). Omnitronics will then generate an activation file and send it back to you. Online Activation If the computer on which you want to activate Omnitronics AGS is connected to the Internet, you can use the following procedure to activate online. To activate the product online after expiry of trial period 1 On the actual computer on which activation is required, run your browser and navigate to the Omnitronics Customer Portal Login site located at the following address: This displays the Product Key Login page. 2 In the Product Key text box, copy and paste the product key as purchased from Omnitronics. 16 Getting Started

25 3 Click Login. Once you have successfully logged in, the following page appears. 4 Click Online Activation. Your Omnitronics AGS installation should now be activated. Offline Activation If the computer on which you want to activate Omnitronics AGS is not connected to the Internet, but you have another computer with Internet access, you can use the following procedure to activate offline. To activate the product offline after expiry of trial period 1 On a computer with Internet access, run your browser and navigate to the Omnitronics Customer Portal Login site located at the following address: This displays the Product Key Login page. 2 In the Product Key text box, copy and paste the product key as purchased from Omnitronics. Omnitronics AGS User Manual 17

26 3 Click Login. Once you have successfully logged in, the following page appears. 4 Click Offline Activation. This displays the Generate License form shown below. 5 Click Download RUS to download the Remote Update System tool. 6 Click Save to save the RUS tool to a portable storage device (USB drive). 7 On the offline computer (on which activation is required), run the RUS tool you downloaded and saved in steps 5 and 6. The RUS main screen will be displayed with the Collect Status Information tab shown. 18 Getting Started

27 8 On the Collect Status Information tab, select Installation of new protection key. 9 Click Collect Information to generate a C2V host-fingerprint file. The Save Key Status As file dialog is displayed. 10 In the File Name text box, type the name of the file you want to save (e.g., JOEC- PC.C2V). 11 Tap Save to save the C2V file to a portable storage device (USB drive). This host-fingerprint file will be required on the online computer. 12 Click Upload C2V button. 13 In the Upload dialog, select the C2V host-fingerprint file on the portable storage device from step Click Generate to generate a vendor-to-customer (V2C). Once the V2C file is generated, the following screen is displayed. 15 Click the Download V2C File link to save the file to a portable storage device (USB drive). This vendor-to-customer (C2V) file will be required on the offline computer. Omnitronics AGS User Manual 19

28 16 On the offline computer (on which activation is required), run the RUS tool you downloaded and saved in steps 5 and Click the Apply License File tab. 18 Click Update File button. 19 Select the V2C file on the portable storage device from step Click Apply Update to conclude the activation. Omnitronics AGS should now be activated on the offline computer. Transferring the Product License You can transfer your AGS product license from one installation (the source computer) to another (the recipient computer) without incurring an additional activation fee. Once you do this, the license on the source computer is deactivated and you will no longer be able to use AGS on that computer. To transfer the product license, you must use RUS, the Remote Update System tool in the Omnitronics AGS installation folder. This involves several steps as listed below. Important: If the computer on which AGS is installed is no longer operational (e.g., hard drive failure), or if you replace the computer mainboard or CPU, you cannot transfer the license, and you will need to contact your Omnitronics Sales Representative to purchase a new license. To transfer the license to another installation 1 On the computer to which you want to transfer the license (the recipient computer), install Omnitronics AGS (see Installing and Uninstalling Omnitronics AGS on page 5). 2 On the Start menu, point to All Programs, Omnitronics, Omnitronics AGS, and then click License Remote Update Tool (RUS). 3 Select the Transfer License tab. 4 Next to Save recipient information to, click. 20 Getting Started

29 5 From the Save recipient information as window, select a folder on a network share or a portable storage device (such as a USB drive), and then type the name for the file (e.g., Omnitronics-AGS-License ). 6 Click Save to close the window. 7 Click Collect and Save Information. This generates a recipient information (.id) file for the recipient computer. It is saved to the file you specified in step 5. Ensure that this file or a copy of this file is accessible on the computer that currently contains the license (you will need this file in a later step). 8 On the Start menu of the computer from which you want to transfer the license (the source computer ), point to All Programs, Omnitronics, Omnitronics AGS, and then click License Remote Update Tool (RUS). 9 Select the Transfer License tab. 10 Next to Read the recipient information file from, click. Omnitronics AGS User Manual 21

30 11 From the Select the recipient information file window, select the file you saved in step 7 (e.g., Omnitronics-AGS-License ), and then click Open. 12 Next to Generate the license transfer file to, click. 13 From the Save the transfer license file as window, select a folder on a network share or a portable storage device (such as a USB drive), and then type the name for the file (e.g., Omnitronics-AGS-License ). 14 Click Save to close the window. 15 Click Generate License Transfer File. This deactivates the license on the source computer and generates the license transfer (.h2h) file you specified in step 13. Ensure that this file or a copy of this file is accessible on the computer to which you want to transfer the license (you will need this file in a later step). 22 Getting Started

31 Note If a license key is not shown in the Generate the license transfer file list and the Generate License Transfer File button remains disabled, there may be a file-permission issue or anti-virus software is blocking RUS. To resolve this, run RUS as administrator and disable anti-virus software while performing the license transfer. 16 On the source computer, close the RUS tool. 17 On the recipient computer, select the Apply License File tab. 18 Next to Update File, click. 19 From the Select the file to apply window, select the license transfer (.h2h) file you saved in step 15, and then click Open. The path and filename of the file appears in the Update File text box. 20 Click Apply Update. This transfers the license from the source to the recipient computer. 21 On the recipient computer, close the RUS tool. The Omnitronics AGS license should now be transferred to the recipient computer and you should now be able to run Omnitronics AGS on that computer. Omnitronics AGS User Manual 23

32 Reinstalling the Product License If you reinstall windows on the computer that runs Omnitronics AGS, you must also reinstall your software and activate it again using the license key originally ed to you when you purchased it. Should you have any questions about reinstalling the product license, please contact Omnitronics Technical Support for further assistance. Replacement Product Software License due to Hardware Failure Loss of software product license will occur as a result of computer hardware failure. This is not covered under warranty and requires Omnitronics to issue a new replacement license. To request a replacement license, contact Omnitronics support. You must be in possession of the product (if it is damaged or defective) and be able to provide proof of purchase. The customer service representative will advise you of any replacement costs that may be charged. If a product is no longer under warranty, the replacement item may no longer be available. Resolving Licensing Issues You need a valid license to use the Advanced GPS Service. If the Advanced GPS Service trial period has expired and you have not applied a valid license key, the Advanced GPS Service will no longer send updates to third-party software, Omnitronics ALS Server, or write new entries to the SQLite/Microsoft SQL Server database (if configured). If you have an appropriate license, but cannot access the advanced GPS data, you may have a licensing issue. If you suspect this to be the case, log in to the configuration interface (see Logging in on page 28) and check the status (see Viewing the System Status on page 30). On the Status page, you will see an error message with an error code of 99 stating that the license is unknown and that you need to activate your product, as shown in Figure 2. Figure 2. Licensing error message 24 Getting Started

33 This message indicates that the Sentinel LDK License Manager service may not be running on your computer. This occurs when the service is stopped or is removed from the list of start-up services. To resolve the licensing issue 1 On the computer on which you installed AGS, go to the Start menu and type services.msc in the Search programs and files text box. The services.msc program should appear as the first and only item in the search results. 2 Click on the services.msc item. You should now see the list of services. It may be helpful to sort the list in ascending alphabetical order. 3 Scroll down the list to find the Sentinel LDK License Manager service. If you do not see the service in the list, either it was not installed with AGS or it was removed. 4 Do one of the following: If Sentinel is not in the list, reinstall AGS and ensure you select the installation option to Install Sentinel LDK Run-time Environment. If Sentinel is in the list, but its status shows that it is not Running, right-click the service, and then select Start. Sentinel LDK License Manager should now be installed and running and you should see it in the list of services with a status of Running. You should now be able to use the Advanced GPS Service. Omnitronics AGS User Manual 25

34

35 Configuration This section discusses how to configure the Omnitronics Advanced GPS Service (AGS). Configuration is usually performed by the system administrator. A valid license is required in order to use the AGS functionality with Omnitronics Dispatch Consoles. However, the basic GPS Essentials functionality of RediTALK-Flex and Alto works without Omnitronics AGS and does not rely on it in any way. This section includes the following topics: Understanding the Configuration Interface Logging in on page 28 Viewing the System Status on page 30 Configuring the System Settings on page 33 Changing the Password on page 42 Backing up & Restoring the Configuration on page 43 Product Activation on page 46 Exiting the Configuration Interface on page 47 Understanding the Configuration Interface All configuration and management of the Omnitronics Advanced GPS Service is done using the built-in configuration interface. You must log in to the configuration interface with a user name and a password before you can view or change any of the configuration settings. The configuration interface is compatible with a wide range of web browsers. As at the date of publication, the configuration interface is compatible with the following web browsers: Internet Explorer 9 11, Edge 38 Mozilla Firefox 50 or later Google Chrome 54 or later Safari 5 or later The configuration interface may also be compatible with other browsers; however, Omnitronics cannot guarantee the compatibility of such browsers. Omnitronics AGS User Manual 27

36 Figure 3 shows the Omnitronics AGS configuration interface once you log in the page shown here is the Location Server Settings page that appears when you select the Location Server on the Settings menu. Navigation panel Menu of configuration pages Configuration panel Displays the name of selected page Settings Displays the settings for selected page Figure 3. Using the AGS configuration interface Control panel Saves or cancels The left-hand side of the configuration interface is the navigation panel, which displays a menu for each of the available configuration pages. Select a menu in the navigation panel to display the corresponding configuration page in the configuration panel on the right-hand side of the configuration interface. Along the lower edge of the configuration interface is the control panel. This panel contains control buttons to save or cancel changes to the configuration. When you are done making changes to the configuration, you should always save your changes by clicking Save, and then exit by clicking Exit. This will take you back to the login page and prevent unauthorized access. Important: The web pages make extensive use of JavaScript so you should ensure that JavaScript is enabled in your web browser. Logging in To configure Omnitronics Advanced GPS Service (AGS), you need to login to the configuration interface by providing the user name and password. You can use the following procedure to login. This assumes you are using Mozilla Firefox web browser, however, the same steps will also apply to other browsers. 28 Configuration

37 To login to the AGS configuration interface 1 In the address bar of your web browser, type the URL of the Omnitronics AGS configuration interface (e.g., The login page similar to one shown below is displayed. 2 Click Log in to show the password dialog. 3 In the password dialog, type omni for the user name, and type gps for the password. 4 Click OK to log in. Important: The password is case sensitive and must be typed in lowercase characters make sure the Caps Lock key is not active on your computer keyboard. The Status page is displayed (see Viewing the System Status on page 30) you can now access the various configuration pages to check the settings and to make changes as required. Omnitronics AGS User Manual 29

38 Viewing the System Status When you login to Omnitronics Advanced GPS Service, you will see the Status page displayed in your web browser, as shown in Figure 4. You can also navigate to this page at any time by clicking Status in the navigation panel. Figure 4. Status page This page provides a wealth of information about the status and operation of the Omnitronics AGS Service including the version information, the information used to connect to the third-party location provider, location information from remote devices, and so forth. Click on a section heading to expand or hide the panel for that section. All the values on these panels are read-only so you cannot change any of the values. System Version Information Figure 5 shows an expanded view of the System Version Information panel. It displays the version of the Advanced GPS Service, the date and time the service was last started, and details about the license. This is useful when you want to check the version of the software running on the server in case you want to upgrade it. Figure 5. System Version Information panel 30 Configuration

39 Application Configuration Figure 6 shows an expanded view of the Application Configuration panel. This panel displays the application configuration settings. You can configure these settings on the Application settings page (see Application Settings on page 40). Figure 6. Application Configuration panel Location Server Status Figure 7 shows an expanded view of the Location Server status panel. This panel displays the name and URL of the GPS location server used to provide geofence events together with some useful statistics about the system updates. Figure 7. Location Server status panel Event Status Figure 8 shows an expanded view of the Event Status panel. It displays a list of the last ten events received from the third-party GPS solution provider. These events include things like entering or exiting configured geofences. Figure 8. Event Status panel Omnitronics AGS User Manual 31

40 Device Status Figure 9 shows an expanded view of the Device Status panel. This panel displays a list of all the devices that report back to the Advanced GPS Service to provide location information. Figure 9. Device Status panel Unit Information Figure 10 shows an expanded view of the Unit Information panel. This panel displays the latest location information reported by a portable device. Figure 10. Unit Information panel Locally Persisted Events Figure 11 shows an expanded view of the Locally Persisted Events panel. This panel displays the latest events reported by a portable device, and the events persisted to the AGS database (SQLite or Microsoft SQL Server database if configured). If you see an error reported in Last Database Error, it will relate to the AGS settings configured for MS SQL Server (see Application Configuration on page 31), and/or AGS is having trouble connecting to MS SQL Server. The error will provide details such as incorrect password, user not found, or connection errors etc., and will automatically clear once the problem is resolved. Figure 11. Locally Persisted Events panel 32 Configuration

41 Configuring the System Settings Omnitronics Advanced GPS Service (AGS) provides several configuration pages to help you configure its settings. Select Settings from the navigation panel to display the menu of configuration items: Location Server configures the name and URL of the GPS location server to use (see Location Server Settings on page 33). Devices (DRG) configures a list of all the devices that report location information back to AGS (see Devices (DRG) Settings on page 34). Profiles configures all the event profiles defined in the system (see Profile Settings on page 35). Console Users displays a list of all the console users defined in the system and the profile assigned to each user (see Console User Settings on page 38). Event Severities configures how the different event severities (or types) are presented at the console (see Event Severity Settings on page 39). Application configures the ports to use for connections with Omnitronics ALS and consoles (see Application Settings on page 40). Location Server Settings Select Location Server on the Settings menu to display the settings for the Location Server similar to the one shown in Figure 12. Figure 12. Location Server configuration page On this page, you specify the name and URL of the GPS location server to use and also the update interval. Update Data Format Update Interval Selects the format of the data and includes BIGMmate and Omnitronics AGS XML (this is an XML format specified by Omnitronics that AGS uses to notify Omnitronics ALS and third-party GPS solution providers of device location updates). Specifies the interval in seconds (0 to 3600) to update the location server (0 disables updates). Omnitronics AGS User Manual 33

42 Connection Information Source IP Destination IP Parallel Updates Time Format Unit Identifier Numbering Scheme Specifies the URL to use when connecting to the location server. Specifies the IP address of the windows server or desktop computer hosting AGS this is currently optional. Specifies the IP address of the GPS location server (e.g., ALS Server) this is currently optional. Specifies the number of simultaneous operations (up to a maximum of 500) allowed improving performance on a busy system. However, available server resources such as CPU and memory may determine the effectiveness of this setting. If performance is an issue, it is recommended you increase this setting until you find a suitable balance. Specifies whether to convert the time-stamp of the GPS location data received from radio devices to UTC. The location server requires UTC time. Specifies the unit identifier (UID) for GPS updates from the location server and can be one of the following: Unit ID (Radio ID), Local Fleet ID, or Full Fleet ID. Devices (DRG) Settings Select Devices on the Settings menu to display the Settings Devices configuration page similar to the one shown in Figure 13. Figure 13. Devices configuration page Click to add new devices that you want to track or click to edit existing devices, as shown in Figure 14. Figure 14. Adding a new device or editing an existing device 34 Configuration

43 For each new device you want to add, simply complete the details: Enabled Description IP Address Port Priority Select to enable (or clear to disable) location information for this device. Provides a brief description of the device. Specifies the IPv4 address of the device. Specifies the port used to access the device. Specifies the priority of the device a lower value means a higher priority. If multiple devices attempt to update the same unit (Radio ID) at the same time, priority will be given to the device with the lowest value. Profile Settings Select Profiles on the Settings menu to display the Settings Profiles configuration page similar to the one shown in Figure 21. Figure 15. Profiles configuration page This page lists all the event profiles defined in the system. AGS stores event configuration in a structure called a profile, and provides a default set of events in a profile called the default profile. Profiles are currently only used by the DX-Altus system, and allow GPS events to be filtered and customized before going to the configured Alto user(s). If you wish to filter and customize geofence events for RediTALK-Flex, this may be done using the Advanced GPS configuration in RediTALK-Flex. You can define new event profiles in addition to the default profile, and you can also rename or delete profiles, but you cannot delete the default profile. Omnitronics AGS User Manual 35

44 Profile Properties Each profile contains the full complement of geofence events (see Geofence Events on page 36), and each event includes the following properties: Event Severity Enabled Pop Up Window Event History Message History GPS Essentials Displays the name of the event (e.g., BlastZoneExit). Specifies the severity (or type) of this event: Critical, Warning or Information. Determines whether this event is enabled or disabled (none of the settings has any effect). Determines whether this event will appear on a popup notification window requiring you to dismiss the event. Determines whether this event will be logged to the ALS Event Log. Determines whether this event will be listed in the Messages window. Determines whether this event will highlight its corresponding radio marker when listed on the GPS Map. To edit an existing profile, such as the default profile, select the profile name in the list, and then click to display its Profile Event Settings page. Figure 16 shows the events for the default profile (the profile name appears in the title). Figure 16. Editing the events of the default profile You enable only the events that you want to handle, and for each event that you enable, specify an event severity from the list, and either select or clear the check boxes for the other settings accordingly. Geofence Events A geofence event occurs when a subscriber enters or exits the boundary or buffer region defined by the geofence (note that not all devices report buffer events), or when a subscriber s movement within the geofence causes some other geofence property to trigger an event, such as exceeding the designated speed limit for instance. The geofence event is reported by AGS, and appears in the Event History Log in Alto and RediTALK-Flex. 36 Configuration

45 You assign a severity (or event type) to each of the geofence events. The event severity can be Information, Warning, or Critical. Alto and RediTALK-Flex use the severity to display the events in different colours. A geofence event comprises the geofence name (a descriptive label that identifies the geofence) and the event trigger (the stimulus that caused the event). For instance, if a subscriber exits a geofence identified by the name of Blast Zone, the geofence event would be BlastZoneExit. The following is a list of geofence events currently available: BlastZoneInside NoGoZoneExit BlastZoneInsideBuffer ConfinementZoneEntered BlastZoneExit ConfinementZoneLeft BlastZoneExitBuffer SpeedingInZone EmergencyZoneInside YardEntered EmergencyZoneExit YardLeft NoGoZoneInside SiteArrived NoGoZoneInsideBuffer SiteLeft Adding a New Profile To add a new profile, click and type the name of the new profile in Profile Name text box, as shown in Figure 17. Once you create a new profile, you will need to enable one or more events for the profile and configure the settings of each event accordingly (see Profile Properties on page 36). Figure 17. Adding a new profile or editing an existing profile Renaming a Profile To rename a profile, select the profile name in the list, and then click to display the Profile Edit page for the profile. On this page, type the new name for the profile in the Profile Name text box. Omnitronics AGS User Manual 37

46 Deleting a Profile If you no longer need a profile, you can delete it. To delete a profile, select the profile name in the list, and then click. On the confirmation message box that appears, click Yes to delete the profile. You will not be able to delete a profile that is assigned to a console user who is logged in. Resetting Events to Defaults Sometimes you may want to reset a profile to its default settings. This is especially useful when you want to start with a clean profile and then change one or more settings. To reset a profile, select the profile name in the list, and then click. On the confirmation message box that appears, click Yes to reset the profile. Console User Settings Select Console Users on the Settings menu to display the Settings Console Users configuration page, as shown in Figure 18. This page displays a list of all the console users defined in the system and the name of the profile assigned to each user. Figure 18. Console Users configuration page To allow Omnitronics dispatch consoles (RediTALK-Flex and Alto, the DX-Altus dispatch console) to download the profile for the current logged-in console user, the user name specified in the Name column must match a user name configured in the DX-Altus SCU; otherwise, Alto will use the default profile for that user. Adding a New Console User If you want to associate a console user (or dispatch operator) with an event profile other than the default profile, you must add the console user as a new console user in AGS. To add a new console user, click to display the Console User Edit page, as shown in Figure Configuration

47 Figure 19. Adding a new, or editing an existing, console user Type the name of the new console user in Name text box, and select a profile from the Profile dropdown list. Click Save to save the new console user. When this console user logs in to a compatible Omnitronics dispatch console, such as Alto or RediTALK- Flex, the user will inherit the event configuration from the profile you assigned. Renaming a Console User To rename a console user, select the console user s name in the list, and then click to display the Console User Edit page for the console user. On this page, type the new name for the console user in the Name text box; and then click Save to save the changes. Deleting a Console User If you no longer need a console user, you can delete it from the system. To delete a console user, select the console user s name in the list, and then click. On the confirmation message box that appears, click Yes to delete the user. You will not be able to delete a console user who is logged in. Event Severity Settings Select Event Severities on the Settings menu to display the Settings Event Severities configuration page, as shown in Figure 20. Figure 20. Event Severities configuration page This page displays a list of the event severities (or event types) defined in the system and the settings associated with each severity: Omnitronics AGS User Manual 39

48 Severity Colour Play Audio on Popup Play Audio Repeat Count Shows the predefined event severity: Critical, Warning or Information. Selects the colour to use for the notification message displayed in the dispatch console. Select this option to play an audio announcement when the notification message is displayed. Specifies the number of times the audio announcement will repeat (setting this to 0 will cause the announcement to repeat indefinitely until the user manually dismisses the alert). Application Settings Select Application on the Settings menu to display the Settings Application configuration page, as shown in Figure 21. Figure 21. Application configuration page On this page, you specify the settings to use for communication with AGS: Web Port Number CCP Port Number Set this to the port number to use (default 53579) for the AGS configuration interface. This value is read only and can only be configured in the application configuration file. This file is located in one of the following folders: C:\Program Files (x86)\omnitronics\advanced GPS Service\GpsService.exe.config C:\Program Files\Omnitronics\Advanced GPS Service\GpsService.exe.config Set this to the CCP port number that Omnitronics consoles (RediTALK-Flex/SCU) use for connections to AGS. 40 Configuration

49 Event (Geofence) Port Number AGS Port Number Persist events in database Reverse Geocoding Reverse Geocoding for Legacy Records ArcGIS Geocoding Server Url ArcGIS Application Client Id ArcGIS Application Client Secret Database Type Set this to the port number that Omnitronics ALS Server, or a third-party tracking service, uses to connect with AGS for sending geofence events via an XML data structure. Set this to the port number that AGS listens on for connections from RediTALK-Flex, which uses this port to send Emergency Acknowledgement events. Default port is Select this option to store location events in the AGS database. This is either a Microsoft SQL Server database or a SQLite database depending on the Database Type setting. Select this option to enable the ESRI ArcGIS reverse geocoding storage function of AGS. Can only be used when Persist events in database is selected. When selected, AGS will convert all new latitude/longitude locations that come from configured DRG devices to street addresses and store them under AddressReverseGeoCoded in the AGS database. This function requires that you have an account with ESRI ArcGIS and adequate account service credits to use for geocoding storage. For further information, see: Select this option to geocode historical data in the AGS database (i.e., data that was present in older versions of AGS, or data that was present while Reverse Geocoding was disabled). Legacy record geocoding is performed asynchronously and begins from the newest un-geocoded address to the oldest un-geocoded address in the data base. Additionally, legacy record geocoding is limited to 2000 updates per hour to reduce the ESRI ArcGIS account service credit consumption. Set this to the URL of the geocoding server to retrieve geocoded addresses. This should be set to the default ESRI ArcGIS global geocode server unless you are running your own server. The default ESRI ArcGIS global geocode server URL is: odeserver Set this to the Client ID associated with your ESRI ArcGIS account. Set this to the Client Secret associated with your ESRI ArcGIS account. Selects the type of database you want to use for storing location events. You can select either Microsoft SQL Server (SQL Server Express) or SQLite. Omnitronics AGS User Manual 41

50 Database Server Address (SQL) Database Name (SQL) Database User (SQL) Database Password (SQL) Database File (SQLite) Set this to the address of the Microsoft SQL Server instance to which the AGS database is attached. This can be localhost when AGS is running on the same machine as SQL Server, or the IP address (or machine name)\instance name of SQL Server: \AGS or MyServerName\AGS Set this to the name of the AGS database attached to the SQL Server instance. Set this to the login name to the Microsoft SQL Server instance. Set this to the password for the Microsoft SQL Server login. Set this to the name of the database to use for AGS events when the Database Type is SQLite (this is disabled when using SQL Server). Note: If you change the Web Port Number setting or change any of the geocoding settings (including ArcGIS settings), you must restart the Omnitronics Advanced GPS Service under Windows Services (see Restarting Omnitronics AGS on page 11). Changing the Password Select Change Password on the Security menu to display the User Admin Change Password page, as shown in Figure 22. This page allows you to change the password used to access the Omnitronics AGS configuration interface. You cannot change the user name as this is factory set to omni. Figure 22. Changing the password of the configuration interface To change the password, type the current password into the Current Admin Password text box, type the new password into the New Admin Password text box, and then retype the new password into the Re-enter new Admin Password text box. Make sure you save the new password by clicking Save; otherwise, the new password will not be saved! 42 Configuration

51 Backing up & Restoring the Configuration You can use the backup feature to create a backup of the Omnitronics AGS configuration to a file on your computer in case you need to restore the configuration later, or to load it into a backup computer. It is recommended that you back up the configuration for safekeeping in case it needs to be restored later. Select Backup/Restore under the Utilities menu to display the Backup and Restore page similar to the one shown in Figure 23. Figure 23. Backuping up the configuration Backup backs up the configuration to a file on your computer (see Backing up the Configuration to a File on page 43). Restore restores the configuration from a backup file on your computer (see Restoring the Configuration from a File on page 44). Restore to Defaults resets the Omnitronics AGS configuration to its factorydefault settings. Backing up the Configuration to a File Once you have completed making changes to the Omnitronics AGS configuration, it is recommended that you back up the configuration to a file on your computer for safekeeping. You will be prompted to select a location on your computer to save the file. The default file name is GpsService.config, but you may rename the file if you wish. The images shown here are specific to Firefox 30 web browser; however, other browsers will show similar screens. To back up the configuration 1 On the Backup tab, click Backup to open the browser s Save dialog. Omnitronics AGS User Manual 43

52 2 Select the Save File option, and then click OK to save the configuration. You will be prompted for a folder and file name in the Enter name of file to save to dialog. 3 (Optional) If you want to use a different folder or file name than the default (GpsService.config), type the file name in the File name box. 4 Click Save to save the configuration. When the backup is complete, the file will appear in the browser s list of downloads similar to the one shown below. The configuration is now saved in the specified backup file on your computer. Restoring the Configuration from a File You can restore the Omnitronics AGS configuration to a previously saved configuration (or backup) by restoring the configuration from a backup file on your computer. Click the Restore tab to display the Restore page you should see a page similar to the one shown in Figure 24. Figure 24. Restoring the configuration The Restore feature makes it easy to restore the Omnitronics AGS settings to a previous known configuration. This can be helpful in the case when you want to reconfigure (or restore) the service back to a previous configuration. The following procedure describes how to restore the configuration using Firefox; however, the procedure will be the same for other browsers. 44 Configuration

53 To restore the configuration 1 On the Restore tab, click Browse to open the File Upload dialog. 2 In the File Upload dialog, locate the configuration file on your computer (e.g. GpsService.config), and then click Open. The filename of the file you selected is shown in the Select file text box. 3 Click Restore to load and restore the configuration from the file on your hard disk. The progress of the restore is displayed on the page. Once the backup file is verified for integrity, it is copied to the Omnitronics AGS configuration. Omnitronics AGS User Manual 45

54 A message appears advising you have successfully restored the Omnitronics AGS configuration. If you see a failure message like the one shown below, try repeating the restore procedure again. 4 Click Done. The configuration is now restored and the Status page is displayed. Product Activation Select Activate License from the Utilities menu to display the Utilities Activate License page, as shown in Figure 25. Figure 25. Product activation page On this page, you can activate the Omnitronics AGS product by entering the product key into the text box you should have received a License Product Key when you purchased an Omnitronics AGS product license. After you have entered the product key, click Save to save the information. AGS will attempt to contact the Omnitronics Activation Server over the Internet to activate your product you will need to have an Internet connection to activate your product otherwise you will see an error message similar to the one shown in Figure Configuration

55 Figure 26. Failed to contact the activation server Exiting the Configuration Interface Once you have configured Omnitronics AGS, you should log out to prevent unauthorised access. To do so, simply click Exit on the menu this will return you to the Login page. Omnitronics AGS User Manual 47