| The OpenGTS Project | Follow us on |
|
|
|
| Home | Project | Demo | Documentation | FAQ | More Info | ||||
|
Frequently Asked Questions Here is a list of commonly asked questions regarding the configuration of OpenGTS. This list is continually growing, so check back periodically for updated questions and answers: (Additional information can be found on the Documentation page, and in the runtime config file ' private.xml' file that comes with OpenGTS).
Installation:
Configuration:
Tomcat:
MySQL:
Device Communication Servers and Events:
Troubleshooting:
Miscellaneous: Glossary: 1) What OS platforms are supported by OpenGTS?
OpenGTS has been successfully installed on the following platforms:
2) What is the basic overall architecture of OpenGTS?
top 3) How do I install OpenGTS?
The document "OpenGTS_Config.pdf", included in the downloaded zip file package,
contains step by step information for installing OpenGTS.
top 4) Can I install OpenGTS on a virtual or shared server?
This depends on the features and support provided by the virtual or shared hosting service provider.
You will need to be able to install the software tools required for OpenGTS (Java,
Ant, Tomcat,
MySQL, etc).
You should also have 'ssh' access to the server
to be able to remotely administer the GTS database and tables, restart Tomcat when necessary, and monitor log files.
Each virtual/shared hosting service provider is different, so you will need to check with the specific provider to see
if they support the features you require. These are some of the questions you should ask:
top 5) How do I upgrade OpenGTS to the latest version?
Review the "
README.txt" and "CHANGELOG.txt" files for any notes that may be
important for the new version. The general procedure for updating OpenGTS to the latest version is as follows:
top 6) How do I check my OpenGTS installation to see if it was installed properly?
The procedure for checking the OpenGTS installation is described in Section 3.2 of the
"OpenGTS_Config.pdf" documentation.
The Linux command for checking the OpenGTS installation is as follows:
% cd $GTS_HOME
% bin/checkInstall.sh
This command will check several different aspects of the OpenGTS installation and display a summary
report of its findings. Any errors or warnings should be corrected, or at least understood, before
running the system in a production environment.
top 7) How do I load the sample data into OpenGTS?
Additional documentation for installing sample 'demo' data into the database can be
found in the "
README.txt" file in the OpenGTS "sampleData/" directory at
"sampleData/README.txt".
top 8) How do I change the displayed language translation (ie. locale)?
This can be changed in the '
private.xml' file. On the "Domain" tag, change
the "locale" to the desired 2-letter country code. For example, to change
the language to German, set the Domain "locale" attribute to 'locale="de"'.
(Rebuild/redeploy the 'track.war' file after making any changes to the ' private.xml' file.)
top 9) How do I change the look-and-feel of the web-interface?
The colors and fonts can be changed by modifying the various 'CSS' files located in the directory
"
war/track/css/". The various available 'JSP' files used to display the web-interface are
located in the directory "war/track/jsp/", and and have the name format "loginSession*.jsp".
Which one of these "loginSession" files is used to display the web-interface is controlled in
"private.xml" by the "JSPEntries" tag specification, and the "WebPages"
tag attribute "jsp". See the "private.xml" file for more information.
(Rebuild/redeploy the 'track.war' file after making any changes to the ' private.xml'
file, or any of the CSS files.)
top 10) How do I change the default displayed map location and zoom when no pushpins are displayed?
This can be changed in the '
private.xml' file. Currently, the default latitude/longitude
and zoom centers over the US. To change this to another location, look for the "default.zoom",
"default.lat", and "default.lon" properties in the active "MapProvider",
and change them to the desired value.
(Rebuild/redeploy the 'track.war' file after making any changes to the ' private.xml' file.)
top 11) How do I change the speed settings for the pushpin colors displayed on the Device map?
The actual pushpin icon selection is determined in the JavaScript function "
evHeadingMarkerURL" found in the
JavaScript module located at "war/track/js/maps/jsmap.js". You can change the chosen pushpin, based on the
current speed, by modifying this function. To set the matching "Legend" displayed on the Device map, you
will need to modify the "Legend" tag section of the currently active MapProvider.
top 12) How do I change the displayed data/time formats?
This can be changed in the '
private.xml' file. Look for the "DateFormat" and
"TimeFormat" tag sections.
(Rebuild/redeploy the 'track.war' file after making any changes to the ' private.xml' file.)
top 13) How do I change the map provider?
This can be changed in the '
private.xml' file. Look for the "MapProvider" tag
sections and enable the desired MapProvider (ie. 'active="true"'), while
disabling the other MapProviders (ie. 'active="false"'). Make sure you comply with
the terms-of-use for the map-provider which you are using.
(Rebuild/redeploy the 'track.war' file after making any changes to the ' private.xml' file.)
top 14) How do I enable reverse-geocoding (ie. turning a latitude/longitude into an address)?
There are a couple parts to the configuration. First the "
ReverseGeocodeProvider" must first
be enabled in the 'private.xml' file. "Geonames" is one of the free available reverse-geocode
providers, however, you will need to check to see if reverse-geocoding is supported in the area that you are
interested in. In the 'private.xml' file, enable the ReverseGeocodeProvider you wish to use
(set 'active="true"' for the desired ReverseGeocodeProvider, while setting the other
ReverseGeocodeProvider's 'active="false"'). Next the 'geocodeMode' in the various
Account records must be set to '3' for "full" reverse-geocoding (this allows you to control which Accounts may
have reverse-geocoding service, since some reverse-geocoders are a premium/fee service). Reverse-Geocoding only
occurs on events which arrive after this configuration has been completed. Monitor the device communication
server log files for reverse-geocoding attempts, to verify that it is working properly.
(Rebuild/redeploy the 'track.war' file after making any changes to the ' private.xml' file.)
top 15) How do I change the map and report Calandars to show Monday as the first day of the week?
This can be changed in the '
private.xml' file. Look for the following Property definition:
<Property key="calendar.firstDayOfWeek">0</Property>Then set the value to '1' (ie. 0=Sunday, 1=Monday, ...). (Rebuild/redeploy the 'track.war' file after making any changes to the ' private.xml' file.)
top 16) How do I configure outbound SMTP (EMail) service?
Outbound SMTP (EMail) support can be configured in the '
custom.conf' file. Look for the following Property definitions:
# --- SMTP
# - (outgoing email configuration parameters)
smtp.host=smtp.example.com
smtp.port=465
smtp.user=someuser
smtp.user.emailAddress=someuser@example.com
smtp.password=somepass
smtp.enableSSL=true
Set "smtp.port" to the SMTP server IP address or host name.
Set "smtp.port" to the SMTP service port number.
Set "smtp.user" and "smtp.password" to the outbound SMTP service username and password.
Set "smtp.user.emailAddress" to the "From" email address (if required).
Set "smtp.enableSSL" to "true" if the outbound SMTP service requires SSL.
(Rebuild/redeploy the 'track.war' file after making any changes to the ' custom.conf' file.)
top 17) How do I change the Tomcat listen port?
The default port "8080" can be changed in the Tomcat '
server.xml' configuration file
at "$CATALINA_HOME/conf/server.xml". Note that on Linux, binding to to a port less
than (or equal-to) 1024 requires that Tomcat be run as 'root',which is not recommended.
If you wish to access the web-interface on port 80, an alternative method would be to use
'iptables' to forward requrest on port 80 to port 8080. This can be accomplished with
the following example 'iptables' entries:
/sbin/iptables -t nat -I PREROUTING -p tcp --dport 443 -j REDIRECT --to-ports 8443
/sbin/iptables -t nat -I PREROUTING -p tcp --dport 80 -j REDIRECT --to-ports 8080
top
18) How do I change the default session timeout value for Tomcat?
This can be changed in the Tomcat default "
web.xml" file found in the Tomcat
directory "$CATALINA_HOME/conf/web.xml". Here is the section of the "web.xml"
file that sets the timeout to 30 minutes:
<session-config>
<session-timeout>30</session-timeout>
</session-config>
You can change this value to any desired length of time. Tomcat should be restarted after this value
has been changed. (Note: setting this value too large may cause excessive resources to be consumes
by users which have logged in, but are not actually using the system).
top 19) How do I increase the number of allowed MySQL connections?
Currently, each thread process is allocated a MySQL connection (for simultaneous device communication
server connections, etc). To increase the number of allow MySQL connections, add the following to the
MySQL config file "
/etc/my.cnf", in the [mysqld] section:
max_connections=200
max_user_connections=200
Restart MySQL after changing this configuration.
top 20) How do I reset the MySQL 'root' password?
If you have forgotten the MySQL 'root' password, it can be reset using this procedure recommended by 'dev.mysql.com':
http://dev.mysql.com/doc/refman/5.0/en/resetting-permissions.html
top
21) How do I use a Boost Mobile Motorola GPS phone with OpenGTS?
For information regarding support for various Boost Mobile Motorola phones, please see the document
at "
MotoDMTP/MotoDMTP.txt" in the OpenGTS installation directory.
top 22) How do I use a Sanav GC-101/GX-101 with OpenGTS?
Additional documentation for installing and configuring the GC-101 server within OpenGTS can be
found in the "
README.txt" file in the "gc101" source directory at
"src/org/opengts/war/gc101/README.txt".
top 23) What is the best GPS tracking/telematic hardware?
The best hardware greatly depends on the specific requirements for the GPS tracking/telematic application.
Here are some of the questions that need to be answered to best fit the GPS tracking/telematic hardware to the applicaton:
top 24) How do I create my own device communication server?
In order for OpenGTS to receive data from a device, a customized "Device Communication Server" will need to be implemented that
understands the protocol used to communicate with the remote device, and insert received events into the SQL database.
Chapter 8 of the "OpenGTS_Config.pdf" installation/configuration document
(also included in the downloaded zip file) describes the starting point for implementing your own "Device Communication Server".
top 25) How is GPS tracking/telematic data sent from the device to the server?
Depending on the capabilities of the device, data can be transmitted to the server in one of several ways.
The following describes some of the methods used by devices to transmit data to the server:
top 26) Why does my event table contain events dated in the future, and how do I delete them?
Occasionally some GPS tracking devices will send an event to the server with a date/time which is in the future, sometimes
a long time into the future. This can be caused by marginal GPS converage. This condition can be prevented by setting
the following properties in the "
common.conf" file:
Device.futureDate.action=ignore
Device.futureDate.maximumSec=86400
The above specification will cause all events to be ignored which are more than 1 day (86400 seconds) into the future.The following command can be used to obtain a count of all future events for a specific account and device:
cd $GTS_HOME
bin/admin.sh Account -account=myaccount -device=mydevice -countFutureEvents=3600
The above command will display a count of events which are more than 1 hour (3600 seconds) into the future. [replace
"myaccount" and "mydevice" with the desired account/device id.]The following command can be used to delete these future events for a specific account and device:
cd $GTS_HOME
bin/admin.sh Account -account=myaccount -device=mydevice -deleteFutureEvents=3600
The above command will delete events which are more than 1 hour (3600 seconds) into the future. [replace
"myaccount" and "mydevice" with the desired account/device id.]top 27) How do I trim/delete old events from the EventData table?
The following command can be used to obtain a count of all old events for a specific account and device (v2.2.7+ only):
cd $GTS_HOME
bin/admin.sh Account -account=myaccount -device=mydevice -countOldEvents=-120d
The above command will display a count of events which are more than 120 days old. [replace
"myaccount" and "mydevice" with the desired account/device id.]The following command can be used to delete these old events for a specific account and device (v2.2.7+ only):
cd $GTS_HOME
bin/admin.sh Account -account=myaccount -device=mydevice -deleteOldEvents=-120d
The above command will delete events which are more than 120 days old. [replace
"myaccount" and "mydevice" with the desired account/device id.]top 28) How do I fix the login error "Error reading Account"?
When attempting to log-in, if you see an error panel which displays "Error reading Account", this is
usually due to the OpenGTS database not having been properly initialized for MySQL (or if MySQL is not
currently running). Refer to the "OpenGTS_Config.pdf"
document for how to initialize the OpenGTS database for MySQL, then run the "
bin/checkInstall.sh"
command to check the installation (see "How do I check my OpenGTS installation
to see if it was installed properly?" above). If the error persists, then also check the Tomcat log
files (ie. "$CATALINA_HOME/logs/catalina.out") to see if it presents any clues regarding why
the database error is occurring.
top 29) How do I fix the web-page Status 404 error "'private.xml' contains syntax/parsing errors"?
This occurs when the file '
private.xml' has been modified, and XML syntax errors have been introduced
into the file. Running the command "bin/checkInstall.sh" should help pinpoint where in the file the
XML syntax errors exist. Fix the XML syntax errors, then re-run the "bin/checkInstall.sh"
command to see if the XML syntax errors were corrected. Then rebuild/redploy the 'track.war' file.
top 30) How do I fix the web-page Status 404 error "The requested resource (/track/Track) is not available"?
This occurs when Tomcat is running, but the '
track.war' file has not been properly deployed to
Tomcat's "webapps" directory (ie. "$CATALINA_HOME/webapps/."). Make sure that the
OpenGTS "build/track.war" file has been copied to the Tomcat "webapps" directory.
Tomcat should then automatically deploy the "track.war" file by unzipping the file and making it
available through the web-interface (if Tomcat does not automatically deploy the track.war file, make sure
that Tomcat's "autoDeploy" property is set to "true", in the Tomcat "conf/server.xml" file).
Also make sure that you are using the proper
URL when attempting to access the login page. Assuming that you have installed Tomcat on the server "localhost",
using port "8080", the correct URL should be "http://localhost:8080/track/Track".
top 31) How do I fix the web-page error "The requested resource (/track/track) is not available"?
URLs are case-sensitive. The correct URL should be specified as "
http://localhost:8080/track/Track",
with the first letter of the second "Track" capitalized.
("localhost" should be replaced with your appropriate domain name).
top 32) After logging-in, selecting any menu option logs me out again.
If everytime you log-in and select a menu option, it always logs you out and displays the login page again, then the
most likely reason is that your client browser is not accepting cookies from the server. The GTS server uses
client-side cookies to maintain session state. If cookies are disabled, the server is not able to determine that
the user has logged-in. To correct this, configure your client browser to accept cookies from the server providing
the GTS service.
top 33) How do I find out more about other commercially available tracking/telematic features?
You can find additional information regarding the features available in the commercial GTS Enterprise
at the following link:
http://www.geotelematic.com/gts.html
top
Glossary: (abbreviations, and their brief descriptions follow)
top | ||||||
|
