You are on page 1of 61

OpenGTS Installation and Configuration Manual

Copyright 2007-2013 GeoTelematic Solutions, Inc. ll rights reser!e"

OpenGTS Configuration and Installation Manual

Page 1 of 61

Manual Revision HIstory Rev


0.0.1 0.0.2 0.0.3 0.0.0.0.$ 0.0./ 0.0.7 0.0.8 0.0.: 0.0.10 0.0.11 0.0.12 0.1.1 0.1.2 0.1.3 0.1.0.1.$ 0.1./ 0.1.7 0.1.8 0.1.: 0.1.10 0.1.11 0.1.12 0.1.13 0.1.10.2.0 0.2.1 0.3.0 0.3.1 0.3.2 0.3.3 0.3.0.3.$ 0.3./ 0.-.1 0.-.2 0.-.3 0.-.0.-.$

Date
2007#03#2$ 2007#03#30 2007#0-#22 2007#0$#0/ 2007#0$#2$ 2007#0/#03 2007#0/#13 2007#0/#30 2007#07#12007#07#27 2007#08#0: 2007#0:#1/ 2007#11#30 2008#02#0/ 2008#02#17 2008#02#20 2008#03#28 2008#0-#11 2008#0$#12008#0/#20 2008#07#08 2008#07#27 2008#10#1/ 2008#12#01 2008#12#1/ 200:#02#01 200:#0-#02 200:#0$#2200:#07#01 200:#08#02 200:#08#23 200:#10#30 2010#0/#18 2010#07#08 2010#0:#10 2011#03#08 2011#0-#01 2011#08#21 2012#12#27 2013#KK#KK

Changed
Initial %elease ""e" in)ormation )or *+ser* ta,le a"ministration Change" top-le!el ant targets )or e!ent, mologogo, an" trac. ser!let ,uil"s. &inor type changes, an" paragraph#page )ormat changes.. ""e" notes )or 0in"o1s users. ll comman"-line prompts in italic )ont.. ""e" note a,out registering )or a Google &ap .ey.

Author
&'( &'( &'( &'( &'( &'( &'( &'( ""itional comments regar"ing re-"eployment o) &'( &'( &'( &'( &'( &'( &'( &'( &'( &'( ""e" a""itional comments to 5ocaliAation section.. &'( &'( &'( ""e" in)ormation regar"ing customiAation o) map 6ushpins.. &'( &'( &'( &'( &'( ""e" a""itional *"e!ice communication ser!er* start#stop in)ormation. &'( &'( ""e" section on =Creating#&o"i)ying %eports=. ""e" notes &'( &'( &'( &'( ""e" in)ormation regar"ing the &'( &'( &'( ""e" a""itional in)ormation on the =gprmc= http&'( &'( &'(

""e" notes regar"ing support )or &icroso)t 2irtual 3arth.

""e" notes )or 0in"o1s users regar"ing setting installation en!ironment !aria,les.

+p"ate" &yS45 "o1nloa" lin.s. Inclu"e nt !1.7.0 "o1nloa" lin.s. ""e" a""itional "ata,ase a"ministration "ocumentation. ""e" a""itional lin. )or &yS45 0in96 "o1nloa". ""itional comments regar"ing ;a!a<eans cti!ation (rame1or. &inor note changes. =trac..1ar=. Change" comman" name =ser!er>mys?l.@= to =ser!er>"mtp.@=. ""e" note regar"ing installing a 6erl interpreter on 0in"o1s. (i7e" minor typos.

%emo!e" re)erence to the creation o) "e)ault account =open"mtp=, "e!ice =mo,ile=, 1hen initialiAing the "ata,ase 1ith =init",=. ""e" comman"s 1hich are e?ui!alent to running =init",=. ""e" comments regar"ing customiAation o) the =1e,app.con)= ser!let runtime con)iguation )ile. ""e" some a""itional comments regar"ing the *3!ents* ser!let. Ta,le a"min comman"s change" )rom =,in#a"minBTa,leC.sh ...= to =a"min.sh BTa,leC ...=. '&T6 ser!er startup script change" to =runser!er.sh -s gts"mtp=. ""e" comments regar"ing ,atch )ile use on 0in"o1s. ""e" notes regar"ing using *template* an" *gprmc* )or creating custom "e!ice ser!ers..

""e" a""itional note on using *", "min.pl* to a"" missing ta,le columns. &inor te7t changes ma"e. ""e" comment to prere?uisites regar"ing the installation o) Tomcat on 5inu7. ""e" section on InternationaliAation#5ocaliAation. ""e" in)ormation regar"ing the implementation o) "e!ice communication ser!ers.

""e" a""itional comments regar"in con)iguration o) Tomcat on 'e,ian#+,untu ;a!a S'D $.0 is no1 re?uire" to ,uil" EpenGTS. ""e" a section on installation testing +p"ate" =Compile= section to inclu"e =ant all=.

+p"ate" location o) *pri!ate.7ml* )ile. +p"ate" the "o1nloa" lin. in)ormation )or !arious mo"ules. ""e" a""itional comments regar"ing ,uil"ing the e7ample *template* ser!er. ""e" note regar"ing *,inF",Con)ig.,at* comman" a!aila,le )or 0in"o1s users. 2arious minor changes +p"ate" the *'ata,ase "ministration* section +p"ate pache Tomcat "o1nloa" +%5 &iscellaneous up"ates ""e" &ac ES 9 con)iguration in)ormation. %earrange" chapters. ""e" section on installing &oto'&T6 ""e" notes regar"ing =e!ents.1ar= support )or e7porting G69 )ormatte" e!ents. on !ali"ating 5ocalStrings )iles.

""e" a""itional comments regar"ing =e!ents.1ar= use )or Google 3arth map up"ates, note regar"ing customiAing the loog-an"-)eel, etc. ""e" comments regar"ing running =runser!er.,at= on 0in"o1s. +p"ate" Tomcat !ersion to $.$.28. ""e" *-sen"&ail* option to *chec.Install* comman". +p"ate" in)ormaton regar"ing *runser!er*, starting#stopping "e!ice communication ser!ers, an" using *psGa!a*. "e!ice communication ser!ers runtime con)iguration ="cser!ers.7ml= )ile. ""e" GTS system architecture section. +p"ate" !arious pre-re?uisite lin.s. +p"ate" starting#stopping 'CS. ""e" a""itional ='e!ice= a"min options. ""e" =Eptional Ta,le Columns=

6lace" 6rere?uisite an" EpenGTS installations into separate chapters. %enum,ere" chapters. ,ase" "e!ice communication ser!er. ""e" Trac.stic. CS2 "ata import in)ormation H!2.3.2I. (i7e" minor typos, etc.

&isc changes. ""e" ;SEJ )ile )ormat to =e!ents.1ar= "escription. +p"ate ;a!a&ail "o1nloa" 2ersion#+%5. ""e" in)ormation on starting the TD107 'CS mo"ule. Inclu"e" ta,le optional )iel" names. +p"ate lin.s.

OpenGTS Configuration and Installation Manual

Page 2 of 61

OpenGTS Installation/Configuration
Contents: 1 Introduction 1 1 Supported !latfor"s 1 # S$ste" Architecture 1 % !lanned &nhance"ents 1 ' Docu"ent Conventions (oading the !rere)uisite Modules # 1 *ava Co"piler # # *avaMail Support # % Apache +Ant+ ,uild Tool # ' Apache +To"cat+ Servlet Container # - M$S.( Data/ase !rovider # 0 M$S.( *D,C Driver Installing/Co"piling the OpenGTS Source % 1 1n2ipping/Installing the OpenGTS Source % # Setting the &nviron"ent 3aria/les % % Co"piling the Supporting GTS (i/rar$ 4iles Initiali2ation and Installation Testing ' 1 Initiali2ing the S.( Data/ase Ta/les ' # Testing the Installation ' % (oading the Sa"ple Data ' ' Creating the +s$sad"in+ Account Installing 5trac6 7ar8 - 1 Configuring the 57e/app conf8 4ile - # Configuring the Availa/le Reports - % Configuring the !rivate (a/el (oo6 and 4eel - ' Co"piling/Installing the 5trac6 7ar8 Servlet - - Testing the Installation - 0 Installing Multiple 3ersions of +trac6 7ar+ Installing 5events 7ar8 0 1 Configuring the 57e/app conf8 file 0 # Co"piling/Installing the 5events 7ar8 *ava Servlet 0 % Testing the installation Data/ase Ad"inistration 9 1 Creating/&diting Accounts 9 # Creating/&diting 1sers 9 % Creating/&diting Devices 9 ' General Data/ase Ad"inistrative 4unctions Installing/Starting the OpenDMT!; T<1=>; and Aspicore DCS Modules : 1 Configuring the +dcservers >"l+ 4ile : # Starting the Device Co""unication Server : % Stopping the Device Co""unication Server : ' Adding a ?e7 Device Record Creating Aour O7n Device Co""unication Server @ 1 BTT!C,ased Device Co""unication Servers Dusing the +gpr"c+ servletE @ 1 1 Configuring the +gpr"c+ Servlet @ 1 # Default +gpr"c+ Configuration @ 1 % ,uilding the +gpr"c+ Servlet @ # Ra7 Soc6etC,ased Device Co""unication Server @ # 1 Starting the Device Co""unication Server @ # # Stopping the Device Co""unication Server @ % Runti"e FM( Configuration 4ile

'

OpenGTS Configuration and Installation Manual

Page 3 of 61

OpenGTS Installation/Configuration
Contents: DcontinuedE 1= Internationali2ation/(ocali2ation 1= 1 Supporting a ?e7 (anguage 1= # Changing the Displa$ed (anguage 11 Creating/Modif$ing Reports 11 1 Report (a$out 11 # Report Data Iterator 11 % Report Definition FM( 11 ' Availa/le Report Specifications Appendi>: AE Support for Microsoft S.( Server ,E Support for Mologogo Capa/le !hones CE Optional Ta/le Colu"ns DE Installing MotoDMT! &E I"porting G!S &vents fro" the Trac6Stic6 Mini

OpenGTS Configuration and Installation Manual

Page 4 of 61

1E Introduction
OpenGTS HOpen Source G6S Trac.ing SystemI is inten"e" to pro!i"e a generic ,ac.-en" 1e,-,ase" ser!ice )or ?uerying an" !ie1ing G6S relate" "ata. It is "esgine" to operate in"epen"ently o) any speci)ic G6S trac.ing "e!ice or protocol, ,ut comes 1ith support )or se!eral "e!ice protocol )ormats Hsuch as OpenDMT! - Epen Source 'e!ice &onitoring an" Trac.ing 6rotocol L httpM##111.open"mtp.orgI. It is speci)ically "esigne" )or use in small to me"ium siAe" commercial enterprises 1ishing to ta.e a"!antage o) G6S trac.ing )or =)leets= o) !ehicles. No1e!er, OpenGTS is highly con)igura,le an" scala,le to larger enterprises as 1ell. En the ser!er si"e, OpenGTS is "esigne" to ,e "e!ice an" protocol in"epen"ent. In or"er to use the )eatures o) OpenGTS, a speci)ic "e!ice#protocol communication ser!er 1ill nee" to ,e implemente" to communicate 1ith the remote "e!ice an" place the "ata in the S45 "ata,ase. OpenGTS ships 1ith support )or OpenDMT! HhttpM##111.open"mtp.orgI so that OpenDMT! compliant "e!ices 1ill ,e rea"y to imme"iately utiliAe the ser!ices o) OpenGTS. custom "e!ice communication ser!er can also ,e implemente" using the inclu"e" e7ample ser!er source co"e. See the chapter title" =Creating Oour E1n 'e!ice Communication Ser!er= )or more in)ormation. En the 1e,-inter)ace si"e, the user presentation is easily customiAa,le to )it the in"i!i"ual "esire" moti). &enu options an" )eatures are also easily customiAa,le to )it speci)ic re?uirements. The source co"e )or the EpenGTS proGect may ,e "o1nloa"e" )rom Source(orge at the )ollo1ing lin.M httpsM##source)orge.net#proGects#opengts#)iles# H5icense" un"er the pache 5icense 2ersion 2M httpM##111.apache.org#licenses#5IC3JS3-2.0I DISC(AIM&R: OpenGTS/OpenDMT! "ust not /e used for an$ illegal activities The providers of this proGect assu"e no responsi/it$ for an$ illegal activities that "a$ /e conducted /$ users of this soft7are
1 1E Supported !latfor"s

OpenGTS is completely implemente" in ;a!a an" shoul" run )ine on any system that )ully supports the ;a!a %untime 3n!ironment. No1e!er, this implementation "oes re?uire an S45 "ata,ase ser!er, an" is there)ore also limite" to systems on 1hich your chosen S45 "ata,ase runs. See the respecti!e S45 "ata,ase support 1e,site )or their supporte" systems Hie. )or &yS45 see =httpM##111.mys?l.org= L 1hich has ,een teste" 1ith OpenGTS on 5inu7, &ac ES 9, (ree<S', Epen<S', an" 0in"o1s-96#2ista#2077 plat)ormsI.
1 #E S$ste" Architecture

This graphic "escri,es the ,asic system architecture o) the OpenGTS system. The !arious "e!ice communication ser!ers Hthe mo"ules 1hich listen )or incoming "ata )rom the remote G6S trac.ing "e!icesI run as separate processes on top o) ;a!a. The Trac. ser!let Hie. The 1e,-inter)aceI, as 1ell as other ser!lets Hinclu"ing any http-,ase" "e!ice communication ser!erI, run 1ithin a Ser!let Container, such as pache Tomcat.

OpenGTS Configuration and Installation Manual

Page 5 of 61

1 %E !lanned &nhance"ents

OpenGTS is al1ays e!ol!ing, an" ne1 )eatures are continually ,eing ma"e a!aila,le. Nere are some general categories o) the )eatures that are in the planning or implementation stageM ""itonal map )eatures. ""itional reports. GTS &nterprise 1as ,uilt on OpenGTS an" has se!eral a""itional )eatures a!aila,le as 1ell Hmore in)ormation regar"ing the GTS 3nterprise can ,e )oun" at =httpM##111.geotelematic.com#gts.html=IM Support )or se!eral Pcommercial useQ mapping ser!ice pro!i"ers. Support )or many a""itional remote G6S trac.ing "e!ices. ""itional reporting options. Simple *%ules* engine to sen" noti)ications ,ase" on criteria )rom incoming e!ents Henhance" 3!ent Joti)ication %ules 3ngine is also a!aila,leI. Contact us regar"ing the a!aila,ility o) these an" other )eatures at =opengtsRgeotelematic.com=.
1 'E Docu"ent Conventions

In or"er to pro!i"e a generic installation#con)iguration "ocument that co!ers !arious systems types Hie. 0in"o1s 96, &ac ES 9, an" the !arious 5inu7 "istri,utionsI, an" the !arious !ersions o) the OpenGTS system, the )ollo1ing con!entions an" assumptions ha!e ,een a"opte" 1ithin this "ocumentM 1I This "ocument 1ill assume that the target operating system is 5inu7-,ase". (or other operating system types, the appropriate path separators an" "irectory speci)ications 1ill nee" to ,e use" that match the re?uirements o) your speci)ic operating system. 3n!ironment !aria,le speci)ication may also !ary ,et1een operating systems. (or instance, to "e-re)erence the *A3AHBOM& en!ironment !aira,le, =%JAVA_HOME%= 1oul" ,e speci)ie" on a 0in"o1s system, 1hile =$JAVA_HOME= is speci)ie" on 5inu7 an" &ac ES 9. 2I This "ocument 1ill assume that the "irectory in 1hich OpenGTS 1ill ,e installe" is =/usr/local/=. I) you 1ill ,e installing OpenGTS in a "i))erent "irectory, you 1ill nee" to replace the "irectory re)erences in this "ocument to the "irectory in 1hich OpenGTS 1as installe". 3I OpenGTS has a )re?uent release sche"ule. (or consistency, this "ocument 1ill assume that the !ersion o) OpenGTS to ,e installe" is =OpenGTS_1.2.3=. So re)erences to =OpenGTS_1.2.3= 1ithin this "ocument shoul" ,e replace" 1ith the actual name an" !ersion o) OpenGTS that you 1ill ,e installing. -I En !arious comman" line e7amples, you may see the "irectory speci)ication =/zzz=. This speci)ication is simply a placehol"er name representing some current "irectory on your system, an" not a literal "irectory name e7isting on your system. $I In !arious locations 1ithin this "ocument, comman"-line options are speci)ie" as =-argNa e!"alue=, 1here =argNa e= is the name o) a comman"-line argument, an" ="alue= is the !alue to ,e assigne" to the comman"ine argument. 0hen entering comman"s in 0in"o1s at a 'ES comman" prompt Hsuch as 1hen using the =.#a$= !ersion o) the comman"sI, comman" arguments such as -rootUser=root M1ST either ,e enclose" in ?uotes, as in "-rootUser=root", or ,e speci)ie" 1ith a colon instea" o) an e?ual-sign, as in -rootUser:root Hpre)erre"I. /I In !arious locations 1ithin this "ocument, the "isplaye" comman"-line options may inclu"e e7ample !alues that are to ,e replace" 1ith !alues speci)ic to your re?uirements. (or e7ample, a comman"-line option in"icating an account may ,e speci)ie" as =-accoun$!myaccount= or as =-accoun$!% &accoun$>=. In this case the argument name =-accoun$!= may ,e ta.en literally, 1hile =myaccount= or =% &accoun$>= in"icates a !alue that shoul" ,e replace" 1ith a speci)ic !alue matching your re?uirements. 7I In !arious locations 1ithin this "ocument, the "isplaye" comman"-line options may comman"-line parameters 1hich are optional Hthey only nee" to ,e inclu"e" to )or some applications, or to change the "e)ault ,eha!iorI. These optional parameters 1ill ,e "isplaye" 1ithin s?uare-,rac.ets *S* ... *T* Heg. ='-()r!/$ p/g$s*=I These s?uare-,rac.et 1ill in"icate that the parameter speci)ie" 1ithin the ,rac.ets is optional, "epen"ing on the comman" re?uirements. The s?uare-,rac.ets themsel!es are not to ,e inclu"e" in the entere" comman".
OpenGTS Configuration and Installation Manual

Page 6 of 61

#E (oading the !rere)uisite !ac6ages


I"portant ?ote: Installation o) the OpenGTS prere?uisite mo"ules "oes re?uire at least an interme"iate .no1le"ge o) ho1 to install an" con)igure systems ser!ices such as the ;a!a compiler, pache nt, &yS45 Hor other S45 "ata,ase ser!erI, pache Tomcat Hor other ser!let containerI, an" other relate" technologies. Compiling OpenGTS re?uires that the )ollo1ing pac.ages or applications ,e installe", con)igure", an" running on the local systemM # 1E *ava Co"piler 6ac.ageM ;'D / +p"ate 99 'o1nloa"M httpM##111.oracle.com#technet1or.#Ga!a#Ga!ase#"o1nloa"s#G".-/u2/-"o1nloa"--007$0.html JotesM download just JDK 6 Update XX Note: To avoid potential headaches trying to get the OpenGTS code to compile, make sure you are using the " un Mi!rosystems" version o" the Java !ompiler. The 'other' versions have problems compiling this code. A ter installing the !ava compiler, chec" your version with the ollowing command: java -version #a"e sure it says $Java(TM)$ and $Java HotSpot(TM) Client VM$. ?ote: &a.e sure that the ;a!a S'D installation *#)n* "irectory has ,een a""e" to the !ATB en!ironment !aria,le Hsee ,elo1I. (ailing to "o so may result in compiler errors. IM!ORTA?T ?OT&: Onl$ install the *D< co"ponent; do not install the separate *R& co"ponent The *D< alread$ contains a *R& co"ponent; and the *D< is needed to co"pile the *ava code Baving /oth the *D< and *R& installed on $our s$ste"; "a$ cause so"e confusion 7hen it co"es to co"piling and running the application # 1 aE Mac OS F users: The ;a!a ;'D !1./.0 is li.ely alrea"y installe" on your &ac ES 9 system, so it may not ,e necesary to "o1nloa" another copy o) the ;a!a ;'D. Oour installe" !ersion o) the ;a!a ;'D !.1./.0 may ,e in the )ollo1ing "irectoryM ++++/S&s$e /,)#rar&/-ra e.or/s/Ja"aVM.0ra e.or//Vers)ons/1.1.2/Ho e # 1 /E 4edora/CentOS (inu> users: The (e"ora#CentES ;a!a =Epen;'D 'e!elopment 3n!ironment= can ,e installe" an" use" instea" o) "o1nloa"ing the ;'D/ "irectly )rom Sun &icrosystems. The comman" to install the ;a!a 1./.0 "e!eloper en!ironment on (e"ora#CentES is as )ollo1s Hmust ,e *root* to installIM ++++3++&u +)ns$all+4a"a-1.1.2-open4(/-(e"el The JAVA_HOME en!ironment !aria,le shoul" then ,e set to the )ollo1ingM ++++3++e5por$+JAVA_HOME!/usr/l)#/4" /4a"a-1.1.2-open4(/ Hma.e sure that =/usr/l)#/4" /4a"a-1.1.2-open4(/= matches the name o) the installe" ;a!a ;'D "irectoryI It is recommen"e" to also create a =4a"a= sym,olic lin. in the =/usr/local/= "irectory 1hich points to the ;a!a ;'D installation, as )ollo1sM ++++3++c(+/usr/local ++++3++ln+-s+$JAVA_HOME+4a"a

OpenGTS Configuration and Installation Manual

Page 7 of 61

# #E *avaMail Support 6ac.ageM +%5M UipM Sun ;a!a&ail 6I H!1.$.0I httpsM##Ga!a.net#proGects#Ga!amail#pages#Nome 4a"a5. a)l.4ar

The Gar )ile =4a"a5. a)n.4ar= )rom this "o1nloa" )ile shoul" ,e installe" into the ;a!a e7ten"e" li,rary "irectory as )ollo1s H*root* access re?uire"IM ++++3++c(+/$ p/+ ++++3++cp+4a"a5. a)l.4ar+$JAVA_HOME/4re/l)#/e5$/. H0here =/$ p/= is the "irectory 1here =4a"a5. a)l.4ar= 1as unAippe"I # # aE Mac OS F users: En &ac ES 9, the ;a!a e7ten"e" li,rary "irectory may ,e at the )ollo1ing locationM ++$JAVA_HOME/l)#/e5$ This 1ill allo1 the ;a!a&ail "ri!er to ,e a!aila,le to all running ;a!a co"e, an" Tomcat ser!let en!ironments. HImportant Note# make sure the permissions on the li$rary %ar "iles are &orld'reada$leI # %E Apache +Ant+ ,uild Tool 6ac.ageM nt !1.:.0 'o1nloa"M httpM##ant.apache.org#,in"o1nloa".cgi UipM httpM##archi!e.apache.org#"ist#ant#,inaries#apache-ant-1.:.0-,in.Aip ?ote: &a.e sure that the nt installation *#)n* "irectory has ,een a""e" to the !ATB en!ironment !aria,le Hsee ,elo1I. # % aE Mac OS F users: The latest nt !ersion is li.ely alrea"y installe" on your &ac ES 9 system, so it may not ,e necesary to "o1nloa" another copy o) the pache nt. Oour installe" !ersion o) pache nt may ,e in the )ollo1ing "irectoryM ++++/usr/s6are/an$ # % /E 4edora/CentOS (inu> users: The (e"ora#CentES pache = nt= can ,e installe" an" use" instea" o) "o1nloa"ing the = nt= installation "irectly )rom pache. The comman" to install the = nt= ,uil" en!ironment on (e"ora#CentES is as )ollo1s Hmust ,e *root* to installIM ++++3++&u +)ns$all+an$

OpenGTS Configuration and Installation Manual

Page 8 of 61

# 'E Apache +To"cat+ Servlet Container 6ac.ageM +%5M UipM pache Tomcat !7.7 ser!let container httpM##tomcat.apache.org#"o1nloa"-70.cgi httpM##111.apache.org#"ist#tomcat#tomcat-7#!7.0.-0#,in#apache-tomcat-7.0.-0.Aip

?ote: I) your !ersion o) 5inu7 "istri,ution alrea"y comes 1ith a !ersion o) Tomcat installe", it is still highl$ reco""ended that you start 1ith a !ersion o) Tomcat "o1nloa"e" "irectly )rom the pache 1e,site. This 1ill eliminate or re"uce any permissions or classpath pro,lems that may ,e encountere". Then 1hen e!erything is up an" 1or.ing properly, i) you choose to "o so, you can go ,ac. an" install OpenGTS in the !ersion o) pache Tomcat that 1as shippe"#installe" 1ith your 5inu7 "istri,ution. # ' aE (inu> users installing the do7nloaded Apache To"cat: It is recommen"e" that the manual Tomcat installation ,e installe" in the =/usr/local/= "irectory H*root* access 1ill ,e re?uire" to install into this "irectoryI. The CATALINA_HOME en!ironment !aria,le shoul" then ,e set to the )ollo1ingM ++++$+e5por$+7ATA,8NA_HOME!/usr/local/apac6e-$o ca$-5.55.55 0here =/usr/local/apac6e-$o ca$-5.55.55= matches the name o) the Tomcat installation "irectory. It is recommen"e" to also create a =$o ca$= sym,olic lin. in the =/usr/local/= "irectory 1hich points to the Tomcat installation, as )ollo1sM ++++3++c(+/usr/local ++++3++ln+-s+$7ATA,8NA_HOME+$o ca$ 0ithin the Tomcat installation *,in* "irectory Hie. =$7ATA,8NA_HOME/#)n=I, ma.e sure the e7ecute permissions ,it is set on all =.s6= )iles. I) not set, the )ollo1ing comman" 1ill set the e7ecution ,itM ++++$+c(+$7ATA,8NA_HOME/#)n ++++$+c6 o(+a95+:.s6 I) the e7ecute ,it is not set on these )iles, Tomcat =s$ar$up.s6= an" =s6u$(o.n.s6= comman"s may not ,e a,le to e7ecute. # ' /E De/ian/1/untu users using a preCinstalled Apache To"cat: 0e recommen" "o1nloa"ing the Tomcat !ersion "irectly )rom pache, ho1e!er, i) you still plan on using the 'e,ian#+,untu installe" !ersion o) Tomcat, an" your Tomcat log )iles are )illing up 1ith =Ga!a.security. ccessControl37ception= messages 1hen attempting to access System properties, then you may nee" to create#e"it a Tomcat policy )ile in the =/e$c/$o ca$1/pol)c&.(= "irectory that contains the )ollo1ing in)ormation Hor similarIM ++gran$+co(e;ase+<0)le=$>ca$al)na.6o e?/.e#apps/$rac//@E;-8N-/-<+> ++++per )ss)on+4a"a.u$)l.Aroper$&Aer )ss)on+<:<B+<rea(B.r)$e<C ++++per )ss)on+4a"a.secur)$&.AllAer )ss)onC ++?C ++gran$+co(e;ase+<0)le=$>ca$al)na.6o e?/.e#apps/e"en$s/@E;-8N-/-<+> ++++per )ss)on+4a"a.u$)l.Aroper$&Aer )ss)on+<:<B+<rea(B.r)$e<C ++++per )ss)on+4a"a.secur)$&.AllAer )ss)onC ++?C ++gran$+co(e;ase+<0)le=$>ca$al)na.6o e?/.e#apps/ ologogo/@E;-8N-/-<+> ++++per )ss)on+4a"a.u$)l.Aroper$&Aer )ss)on+<:<B+<rea(B.r)$e<C ++++per )ss)on+4a"a.secur)$&.AllAer )ss)onC ++?C &a.e sure the a,o!e !alues are appropriate )or your installation.

OpenGTS Configuration and Installation Manual

Page 9 of 61

# -E M$S.( Data/ase !rovider 6ac.ageM +%5M &yS45 !$.9.9 httpM##"e!.mys?l.com#"o1nloa"s#mys?l#

# - aE Iindo7s users: En 0in"o1s, "o1nloa"#install the )ollo1ing )ileM +++ &sDl-essen$)al-E.X.XX- 2-.)n1F. s) 0here = &sDl-essen$)al-E.X.XX- 2-.)n1F. s)= is the name o) the latest &yS45 installation )or 0in"o1s. # - /E Mac OS F users: &yS45 can ,e "o1nloa"e" in the ES 9 pac.age )ormat )rom the )ollo1ing locationMM ++httpM##"e!.mys?l.com#"o1nloa"s#mys?l#$.$.htmlV"o1nloa"s # - cE 4edora/CentOS (inu> users: The (e"ora#CentES =&yS45= can ,e installe" an" use" instea" o) "o1nloa"ing the =&yS45= installation "irectly )rom &yS45. The comman" to install =&yS45= on (e"ora#CentES is as )ollo1s Hmust ,e *root* to installIM ++++3++&u +)ns$all+ &sDl-ser"er+ &sDl ?ote: &a.e sure that the &yS45 installation =#)n= "irectory has ,een a""e" to the !ATB en!ironment !aria,le. # 0E M$S.( *D,C Driver 6ac.ageM +%5M UipM &yS45 Connector#; !$.1.99 ;'<C "ri!er httpM##"e!.mys?l.com#"o1nloa"s#connector#G# &sDl-connec$or-4a"a-E.1.XX.G)p

?ote: Connector#; is "istri,ute" un"er G65. # 0 aE 4edora/CentOS (inu> users: The (e"ora#CentES &yS45 ;'<C "ri!er can ,e installe" an" use" instea" o) "o1nloa"ing the &yS45 ;'<C "ri!er installation "irectly )rom &yS45. The comman" to install =&yS45= on (e"ora#CentES is as )ollo1s Hmust ,e *root* to installIM ++++3++&u +)ns$all+ &sDl-connec$or-4a"a The = &sDl-connec$or-4a"a-E.1.XX.4ar = Gar )ile can then ,e )oun" at the )ollo1ing locationM /usr/s6are/4a"a/ &sDl-connec$or-4a"a-E.1.XX.4ar H1here = &sDl-connec$or-4a"a-E.1.XX.4ar= matches the name o) the install Gar )ileI The Gar )ile = &sDl-connec$or-4a"a-E.1.XX.4ar= )rom this "o1nloa"e" Aip )ile shoul" ,e installe" into the ;a!a e7ten"e" li,rary "irectory as )ollo1s H*root* access re?uire"IM ++++3++c(+XXXXXXXX+ ++++3++cp+ &sDl-connec$or-4a"a-E.1.12-#)n.4ar+$JAVA_HOME/4re/l)#/e5$/. H1here =XXXXXXXX= is the "irectory 1here the &yS45 ;'<C "ri!er 1as unAippe"I # 0 aE Mac OS F users: En &ac ES 9, the ;a!a e7ten"e" li,rary "irectory may ,e at the )ollo1ing locationM ++$JAVA_HOME/l)#/e5$ This 1ill allo1 the ;'<C "ri!er to ,e a!aila,le to all running ;a!a co"e, an" Tomcat ser!let en!ironments. %Important Note# make sure the permissions on the li$rary %ar "iles are &orld'reada$le&
OpenGTS Configuration and Installation Manual

Page 10 of 61

%E Installing/Co"piling the OpenGTS Source


I"portant ?ote: Installation o) the supporte" OpenGTS )eatures "oes re?uire at least an interme"iate .no1le"ge o) ho1 to install an" con)igure systems ser!ices such as the ;a!a compiler, pache nt, &yS45 Hor other S45 "ata,ase ser!erI, pache Tomcat Hor other ser!let containerI, an" other relate" technologies. % 1E 1n2ipping/Installing the OpenGTS Source En 5inu7 systems, it is recommen"e" that the OpenGTS Aip )ile ,e unAippe" an" installe" in the =/usr/local/= "irectory. En 0in"o1s, it can ,e installe" in any con!enient "irectory, such as in the root partition o) =7=H=. (or the purposes o) this "ocument, 1e 1ill assume that the target operating system is 5inu7-,ase", an" that the location 1here OpenGTS 1ill ,e installe"#unAippe" is =/usr/local/OpenGTS_1.2.3/= HJoteM you may nee" to choose another installation "irectory i) you "o not ha!e *root* access on the target systemI. "Gust the )ile#path separators an" comman"s as necessary )or your particular operating system, an" chosen installation "irectory. Install the OpenGTS source code: +nAip the OpenGTS pac.age in =/usr/local/= Hthis 1ill nee" to ,e "one as the =roo$= userI, or other con!enient "irectory Hon 0in"o1s, choose a "irectory 1here you 1oul" li.e this pac.age to ,e place" L pre)erra,ly a path 1hich "oes not contain any em,e""e" spacesI. (or instance, i) the OpenGTS pac.age to ,e installe" is =OpenGTS_1.2.3.G)p=, then the comman" to unAip the pac.age 1oul" ,eM
/zzz>+c(+/usr/local /usr/local>+su+roo$ /usr/local +unG)p+/$ p/OpenGTS_1.2.3.G)p /usr/local +c6o.n+-I+user=group+OpenGTS_1.2.3 /usr/local +e5)$ /usr/local>+e5por$+GTS_HOME!/usr/local/OpenGTS_1.2.3

Hthe a,o!e assumes that OpenGTS_1.2.3.G)p 1as "o1nloa"e" to =/$ p/=. I) the OpenGTS Aip )ile 1as "o1nloa"e" into a "i))erent "irectory, mo"i)y the a,o!e "irectory location an" "o1nloa"e" )ile name accor"ingly. lso, replace the user name =user=, an" group name =group=, a,o!e 1ith the name o) the user=group that you 1ish to ha!e o1n the OpenGTS installationI. H lso note that the =/zzz= "irectory name a,o!e is Gust a placehol"er name 1hich represents any current "irectory that may ,e in e))ect ,e)ore the =c(= comman" is issue"I. % #E Setting the &nviron"ent 3aria/les The )ollo1ing en!ironment !aria,le shoul" ,e set to the installation "irectory o) the correspon"ing pac.age or applicationM

JAVA_HOME L The ;a!a ;'D H?OT the ;%3I installation "irectory. ANT_HOME L The pache nt installation "irectory. CATALINA_HOME L The pache Tomcat installation "irectory. GTS_HOME L The EpenGTS installation "irectory.

OpenGTS Configuration and Installation Manual

Page 11 of 61

% # aE Iindo7s users: The location o) the installation *#)n* "irectories )or the ;a!a S'D, nt, an" S45 "ata,ase ser!er installations, nee"s to ,e a""e" to the comman" e7ecution !ATB en!ironment !aria,le Hi) the installation process has not alrea"y a""e" them to the !ATB !aria,leI. 3n!ironment !aria,les can ,e set manually in a comman"-prompt 1ith the PsetQ comman", as in the )ollo1ing e7ampleM C:\> set GTS_HOME=C:\OpenGTS_1. .! %'hen setting environment variables, (uotes should not be used to enclose an installation directory, even i the directory contains embedded spaces& 3n!ironment !aria,les are re)erence" ,y enclosing them in *%*. (or instance, a)ter setting the en!ironment !aria,le JAVA_HOME to point to your ;'D installation "irectory, this en!ironment !aria,le 1oul" ,e "ere)erence" as P"JAVA_HOME"Q. The )ile path separator is the ,ac.-slash character PHQ. So, 1hile on 5inu7 a )ile#"irectory coul" ,e re)erence" as P#JAVA_HOME$%re$&'($e)t$.Q, on 0in"o1s this same "irectory 1oul" ,e re)erence" as P"JAVA_HOME "\%re\&'(\e)t\.P The a,o!e en!ironment !aria,les can ,e set to ,e automatically "e)ine" 1hen starting a comman"-prompt through the =S$ste" !roperties= 1in"o1 as )ollo1sM %ight-clic. on =M$ Co"puter= an" select =!roperties=, the =S$ste" !roperties= 1in"o1 1ill "isplay. Select the =Advanced= ta,, then press the =&nviron"ent 3aria/les= ,utton. In the =S$ste" 3aria/les$ section, a"" the )ollo1ing !aria,lesM 2aria,le JameM *A3AHBOM& %re(uired or building OpenGTS, and running Tomcat& 2alueM %The location o your !A)A DK *nstallation +older, N() the !,-& 2aria,le JameM A?THBOM& 2alueM %The location o your Ant *nstallation +older& 2aria,le JameM CATA(I?AHBOM& %re(uired or building OpenGTS& 2alueM %The location o your Apach Tomcat *nstallation +older& 2aria,le JameM GTSHBOM& 2alueM %The location o your OpenGTS *nstallation +older& %.uotes should N() be used to enclose an installation directory or these environment variable speci ications, even i the directory contains embedded spaces& 6re)i7 the )ollo1ing to the =!ath= en!ironment !aria,le in the =S$ste" 3aria/les$ section Hcreate a ne1 =!ath= !aria,le i) one "oes not alrea"y e7istIM .C%JAVA_HOME%H#)nC%MJSK,_HOME%H#)nC%ANT_HOME%H#)nC %.uotes may be added to the /AT0 variable i necessary& Clic. =O<= on the =&nviron"ent 3aria/le= 1in"o1. % # /E (inu> users: It is recommen"e" that the )ollo1ing sym,olic lin.s ,e create" 1ithin the =/usr/local/= "irectory 1hich point to their correspon"ing *home* "irectories Hs.ip a gi!en sym,olic lin. i) it has alrea"y ,een create"IM ++++3++c(+/usr/local ++++3++ln+-s+$JAVA_HOME+4a"a ++++3++ln+-s+$7ATA,8NA_HOME+$o ca$ ++++3++ln+-s+$GTS_HOME+g$s

OpenGTS Configuration and Installation Manual

Page 12 of 61

% %E Co"piling the Supporting GTS (i/rar$ 4iles % %aE !reco"piled 3ersions of GTS: I) you ha!e recei!e" a pre-compile" !ersion o) the GTS pac.age, this section may ,e s.ippe" Hho1e!er you may re,uil" the !arious ser!lets an" Gar )iles i) you 1ish to ma.e any changes to the runtime con)iguration ,e)ore "eployment. Co"pile the OpenGTS li/rar$ + Gar +and servlet + 7ar+ files: *c(* into the OpenGTS installation "irectory an" compile the Gar )iles, an" ser!let 1ar )iles, using the supplie" nt =#u)l(.5 l= scriptM
/usr/local>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+an$+all

This 1ill ,uil" se!eral Gar )iles, an" 1ar )iles, in the =$GTS_HOME/#u)l(/= "irectory, inclu"ingM

=l)#/g$su$)ls.4ar= L This Gar contains the ,ase utilities an" ", access tools. =l)#/g$s(#.4ar= L This Gar contains the "ata,ase access utilities an" ta,le "e)inition. =l)#/g$s( $p.4ar= L This Gar contains the S45 ", "atastore 1rappers aroun" the OpenDMT! ser!er. =l)#/$ools.4ar= L This Gar contains miscellaneous system chec. an" a"ministrati!e tools. =$rac/..ar= L This =1ar= )ile H1e,-archi!eI contains the 1e,-inter)ace *Trac.* ser!let. =e"en$s..ar= L This =1ar= )ile contains the 1e, accessi,le 3!ent'ata access ser!let. = ologogo..ar= L This =1ar= )ile contains the &ologogo "e!ice ser!let. =gc121..ar= L This =1ar= )ile contains support )or the Sana! GC-101 "e!ice. =gpr c..ar= L This =1ar= )ile contains a ser!let support ser!er )or a generic http-,ase" "e!ice ser!er.

HJoteM this is only a partial list. Ether mo"ules 1ill ,e create" as 1ellI. The ,uil" shoul" complete normally. There may ,e some 1arnings "isplaye", ho1e!er i) the 1arning or error can ,e ignore", there 1ill also ,e a message in"icating this ne7t to the 1arning#error Hor on a line Gust ,elo1 the 1arning#errorI.

OpenGTS Configuration and Installation Manual

Page 13 of 61

'E Initiali2ation and Installation Testing


<e)ore using OpenGTS, it must )irst ,e initialiAe". This section "escri,es the steps re?uire" )or initialiAation an" testing. ' 1E Initiali2ing the S.( Data/ase Ta/les <e)ore storing "ata in the S45 "ata,ase, it must )irst ,e initialiAe" 1ith the ta,les use" ,y OpenGTS. This can ,e accomplishe" 1ith the =#)n/)n)$.s6= comman" as )ollo1sM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+#)n/)n)$(#.s6+-roo$Lser!(root)ser>+-roo$Aass!(root*ass>

0here (root)ser> is the user 1ith root access to the S45 ser!er, an" (root*ass> is the root user pass1or" Hmay ,e optional "epen"ing on the con)iguration o) your S45 ser!erI. SJET3M This is not the same as the 5inu7 =root= userT ' 1 aE I"portant note regarding + sh+ and + /at+ co""and files: Comman"s en"ing 1ith =.s6= or =.#a$= M1ST ,e e7ecute" )rom the OpenGTS installation "irectory. ttempting to e7ecute these comman"s )rom another "irectory may result in a =ClassJot(oun"37ception= or =JoClass'e)(oun"3rror= error, or similar. HThis means that you must c" to JGTSHBOM&, then e7ecute the comman" as =#)n/%comman+M=I 0in"o1s users may 1ish to install a 6erl interpreter on their machine in or"er to use the 6erl !ersions H=.pl=I o) the comman"-line scripts 1hich "o not re?uire that they ,e e7ecute" )rom the OpenGTS installation "irectory. &ore in)ormation on possi,le 6erl "istri,utions a!aila,le on 0in32 plat)orms may ,e )oun" at this locationM =httpM##1in32.perl.org#1i.i#in"e7.phpKtitleW0in32>'istri,utions= ' 1 /E I"portant note for Iindo7s users: 0hen using the =.#a$= !ersion o) the comman"s in a 'ES 1in"o1, comman" arguments such as -rootUser=root must either ,e enclose" in ?uotes, as in "-rootUser=root", or ,e speci)ie" 1ith a colon instea" o) an e?ual-sign, as in -rootUser:root. Thus, on 0in"o1s, the comman" isM ++#)nH)n)$(#.#a$+<-roo$Lser=user,ame<+<-roo$Aass=user*ass< 0here *user,ame* an" *user*ass* shoul" ,e replace" 1ith the appropriate root user an" pass1or". The =)n)$(#.s6= comman" per)orms the )ollo1ing )unctions 1hen initialiAing the OpenGTS "ata,aseM Creates a "ata,ase calle" =gts=. Creates#Grants user =gts= 1ith pass1or" =opengts= 1ith access to the =gts= "ata,ase. Creates the )ollo1ing ta,les in the =gts= "ata,ase Hthis is only a partial listIM Account - ccount o1ner ta,le 1ser - +ser ta,le 1serAcl - +ser ccess-Control-5ist ta,le Device - 'e!ice in)ormation ta,le &ventData - %ecei!e" 3!ent "ata Geo2one - GeoAone#Geo)ence "e)initions &ventTe"plate - Custom e!ent pac.et templates H'&T6 onlyI !ending!ac6et - 6ac.ets pen"ing transmission to "e!ice H'&T6 onlyI etc. The =)n)$(#.s6= comman" per)orms the same )unctions as the )ollo1ing se?uence o) comman"sM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-crea$e(#+-user!(root)ser> /usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-gran$+-user!(root)ser> /usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-$a#les!ca

OpenGTS Configuration and Installation Manual

Page 14 of 61

?ote for Iindo7s 1sers: =#)n/(#A( )n.pl= is only a!aila,le )or 5inu7 users, an" 0in"o1s users 1hich are running 1ithin a Cyg1in en!ironment. =#)nH(#7on0)g.#a$= pro!i"es a su,set o) the )eatures a!aila,le in =#)n/(#A( )n.pl= 1hich 1ill run )rom a 0in"o1s comman" prompt. ' #E Testing the Installation ' # aE I"portant note regarding + sh+ and + /at+ co""and files: Comman"s en"ing 1ith =.s6= or =.#a$= M1ST ,e e7ecute" )rom the OpenGTS installation "irectory. ttempting to e7ecute these comman"s )rom another "irectory may result in a =ClassJot(oun"37ception= or =JoClass'e)(oun"3rror= error, or similar. HThis means that you must c" to JGTSHBOM&, then e7ecute the comman" as =#)n/%comman+M=I The )ollo1ing comman" has ,een inclu"e" to assist in chec.ing the installation o) the system an" "isplaying any inconsistencies that might cause pro,lems at runtimeM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+#)n/c6ec/8ns$all.s6

Er, on 0in"o1sM
C-.>+c(+%GTS_HOME% C-.!pen"TS#$%&%'>+#)nHc6ec/8ns$all.#a$

This comman" 1ill "isplay !arious con)igure" "irectories an" en!ironment !aria,les. I) any errors are "isplaye", they shoul" ,e correcte" Hor at least un"erstoo"I ,e)ore continuing system "eployment. S&T6 con)iguration is re?uire" to support )eatures such as sen"ing )orgotten email noti)ications, emailing reports, etc. The properties re?uire" )or S&T6 can ,e con)igure" in one o) the =.con0= runtime con)iguration )iles Htypically =cus$o .con0=I. I) you 1ish to test your S&T6 email con)iguration, you can a"" the option =-sen(Ma)l+ %e a)lA((ressM=, 1hich 1ill attempt to sen" a test email to the speci)ie" email a""ressM
/usr/local/!pen"TS#$%&%'>+#)n/c6ec/8ns$all.s6+-sen(Ma)l+ &e a)la((ressNe5a ple.co
Hnote that there are is a space ,et1een the * -sen(Ma)l* option an" the email a""ressI

Er, on 0in"o1sM
C-.!pen"TS#$%&%'>+#)nHc6ec/8ns$all.#a$+-sen(Ma)l= &e a)la((ressNe5a ple.co
Hnote that there are is a *M* ,et1een the * -sen(Ma)l* option an" the email a""ress )or the 0in"o1s !ersion o) the comman"I

%eplace = &e a)la((ressNe5a ple.co = 1ith the email a""ress you 1ish to ha!e recei!e the test email. ' %E (oading the Sa"ple Data Some sample "ata has ,een pro!i"e" 1ith the OpenGTS installation 1hich can ,e loa"e" an" !ie1e" 1ithin the 1e,inter)ace. 6lease re)er to the "ocument at =sa pleOa$a/IEAOME.$5$= 1ithin the OpenGTS installation "irectory )or in)ormation regar"ing ho1 to loa" the sample "ata.

OpenGTS Configuration and Installation Manual

Page 15 of 61

' 'E Creating the +s$sad"in+ Account Hthe =sysa"min= )eature is only a!aila,le 1ith EpenGTS !ersion 2.2.7 an" a,o!eI 0hen logging in to the =s&sa( )n= account a ne1 menu *ta,* 1ill ,e a!aila,le, 1ith ne1 1e,-page selections, that allo1 the creating o) ne1 accounts. The )ollo1ing comman" can ,e use" to create the =s&sa( )n= accountM
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Accoun$+-accoun$!s&sa( )n+-pass!pass.or(+-crea$e

Er, on 0in"o1sM
C-.!pen"TS#$%&%'>+#)nHa( )n.#a$+Accoun$+-accoun$=s&sa( )n+-pass=pass.or(+-crea$e

%eplace the a,o!e =pass.or(= speci)ication 1ith a secure pass1or". Oou shoul" then ,e a,le to log in to the =s&sa( )n= account to see the ne1 =System "min= ta,.

OpenGTS Configuration and Installation Manual

Page 16 of 61

-E Installing 5trac6 7ar8


The =$rac/..ar= HIe,-ARchi!eI runs in a ;a!a Ser!let container an" 1or.s 1ith the S45 '< "atastore to pro!i"e a )ull)eature" 1e, inter)ace to the G6S location "ata capture" in the S45 "ata,ase )rom remote "e!ices. The mapping support currently uses Epen5ayers#EpenStreet&ap, ,ut can ,e con)igure" to use other commercial mapping ser!ice pro!i"ers. - 1E Configuring the +7e/app conf+ file The "e)ault runtime con)iguration )ile =.e#app.con0= inclu"es the )ile =co on.con0=, 1hich in-turn inclu"es =s&s$e .con0= an" =cus$o .con0=. (or most installations, the "e)ault !alues speci)ie" in this )ile can ,e le)t as-is. No1e!er, some items, such as your S&T6 ser!er speci)ications, shoul" ,e con)igure" to )it your system re?uirements. - #E Configuring the availa/le reports 2arious "etail an" summary reports can ,e "e)ine" using the )ile =repor$s.5 l=, 1hich can ,e )oun" at =$GTS_HOME/repor$s.5 l=. &ore "etaile" in)ormation can ,e )oun" in the a,o!e =repor$s.5 l< )ile, an" else1here in this "ocument. Nere is a summary o) the a!aila,le )eatures in the =repor$s.5 l= )ile He7perience in the general )ormat an" e"iting o) 9&5 )iles 1ill ,e necessaryI. =Iepor$,a&ou$= "e)ines the e7pecte" recor" )ormat an" the a!aila,le columns )or the "e)ine" report. The speci)ic report layout is "e)ine" ,y the speci)ie" ;a!a class, an" 2 report layouts ha!e ,een pro!i"e"M

or*.open*ts.+,r.report.e-ent.E-ent.,t,L,/o0t - This layout e7pects to "isplay 3!ent'ata recor"s an" speci)ies a!aila,le columns ,ase" on the )iel"s a!aila,le in the 3!ent'ata recor". or*.open*ts.+,r.report.1'e&2.3'e&2L,/o0t - This layout e7pects to "isplay generic =(iel"'ata= recor"s an" speci)ies !arious a!aila,le columns type 1hich can ,e use" to "isplay pertinent "ata.

The =Iepor$= tag speci)ies a ;a!a class 1hich is ,oun" to a speci)ic Iepor$,a&ou$. The =Iepor$= also speci)ies ho1 it is to ,e presente" to the user Hie. the menu optionI, report title, "isplaye" columns, an" report selection criteria. - %E Configuring the !rivate (a/el loo6 K feel The con)iguration an" customiAation o) the 1e, user inter)ace can ,e speci)ie" in the )ile =$GTS_HOME/pr)"a$e.5 l= Hor =$GTS_HOME/pr)"a$e/pr)"a$e_co on.5 l= )or the GTS 3nterpriseI. This )ile controls the )ollo1ing options that are a!aila,le on a *Oo a)n* ,asis Hthe "omain name o) the re)erence +%5 !isiting the ser!erIM

The 'ate#Time )ormats, an" "isplaye" TimeUones. The &ap6ro!i"er use" Hie. Google &aps, &icroso)t 2irtual 3arth, &apstraction, Epen5ayers, etcI. Inclu"ing 1hat pushpin icons are to ,e "isplaye" on the map. The %e!erseGeoco"e6ro!i"ers use" to con!ert latitu"e#longitu"e !alues into a street a""ress HGeonames, etc.I. The Geoco"e6ro!i"er use" to con!ert street a""resses into a latitu"e#longitu"e Hi) a!aila,leI. !aila,le menu options, 1e,pages, an" customiAing ;S6 )iles. !aila,le report options. ccess-Control-5ist H C5I "e)initions. n" much, much more ... on.5 l=I )ile )or more

6lease re)er to the comments containe" 1ithin the =pr)"a$e.5 l= Hor =pr)"a$e_co in)ormation.

OpenGTS Configuration and Installation Manual

Page 17 of 61

OpenGTS inclu"es mapping support )or Epen5ayers#EpenStreet&ap, Google &aps, &icroso)t 2irtual 3arth, an" &apstraction H1hich can support se!eral other mapping ser!ice pro!i"ers as 1ellI. Contact us regar"ing support )or other commercial mapping ser!ice pro!i"ers. I) you 1ill ,e using Google &aps )or your map pro!i"er, you must also register )or a Google &ap .ey Hma.e sure you comply 1ith their terms o) ser!iceI an" place the returne" .ey in the =pr)"a$e.5 l= Hor =pr)"a$e_co on.5 l=I )ile at the location in"icate" Hie. replace =:::+Alace+Google+Maps+ Pe&+Here+:::= 1ith your ?uote" .eyI. To change the "e)ault "isplaye" map pushpins, you can create your o1n *6ushpins* section 1ithin your chosen &ap6ro!i"er. See the *pr)"a$e.5 l* )ile 6ushpins section Hin the =open,a&ers= &ap6ro!i"er sectionI )or more in)ormation regar"ing customiAing pushpin icons. Consult the contents o) the pro!i"e" pri!ate-la,el )ile at =$GTS_HOME/pr)"a$e.5 l= )or more in)ormation on speci)ic customiAations He7periance in the general )ormat, e"iting, an" synta7 o) 9&5 )iles 1ill ,e necessaryI. - % aE Maintain proper FM( s$nta> 7hen "odif$ing +pr)"a$e.5 l+ or +repor$s.5 l+ &a.e sure that any changes to the *pr)"a$e.5 l* )ile still comply 1ith proper 9&5 synta7. 9&5 is !ery particular a,out proper synta7, an" intro"ucing an 9&5 synta7 error o)ten results in an error message similar to the )ollo1ing 1hen attempting to !ie1 the login page in a 1e, ,ro1serM
8n"al)(+Qpr)"a$e.5 lQ+con0)gura$)onB+please+con$ac$+$6e+S&s$e +A( )n)s$ra$or

%un =#)n/c6ec/8ns$all.s6= to help "iagnose any 9&5 synta7 errors that may ha!e ,een intro"uce". The general loo.-an"-)eel o) the 1e,-inter)ace can also ,e change" ,y mo"i)ying the ;S6 )ile =$GTS_HOME/.ar/$rac//4sp/log)nSess)on.4sp= an" the !arious CSS )iles in the "irectory =$GTS_HOME/.ar/$rac//css/=. 5oo. )or the =@e#Aages= tag section in the =pr)"a$e.5 l= )ile )or a""itional in)ormation regar"ing the customiAation o) the =log)nSess)on.4sp= )ile. - % /E IM!ORTA?T: Redeplo$ all servlets after "odif$ing an$ runti"e configuration file Changes to any o) =pr)"a$e.5 l=, =repor$s.5 l=, =.e#app.con0=, =co on.con0=, =s&s$e .con0=, or =cus$o .con0= )iles Hor other =.5 l= or =.con0= )ileI 1ill re?uire that the =$rac/..ar= Has 1ell as the other ser!letsI )ile ,e re-,uilt an" re-"eploye".

- 'E Co"piling/Installing the +trac6 7ar+ *ava Servlet To ,uil" the =$rac/..ar= )ile, run the nt ,uil" comman" as )ollo1sM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+an$+$rac/
Hnote, the = an$+all= per)orme" a,o!e also ,uil"s the = $rac/..ar= )ileI

The target =$rac/= is a 1rapper )or ant targets =$rac/.co p)le= an" =$rac/..ar=. The target =$rac/.co p)le= compiles all necessary classes an" con)iguration )iles into the ,uil" "irectory =$GTS_HOME/#u)l(/$rac/=. The target =$rac/..ar= then creates the *1e, archi!e* )ile =$GTS_HOME/#u)l(/$rac/..ar=. I) any o) the runtime con)iguration )iles ha!e change", such as =pr)"a$e.5 l=, =repor$s.5 l=, =.e#app.con0=, or =co on.con0= )iles Hor possi,ly any other =:.con0= o) =:.5 l= )ileI, then the =$rac/..ar= )ile must ,e re,uilt an" re"eploye". shortcut to re,uil"ing the =$rac/..ar= )ile, i) all source mo"ules ha!e alrea"y ,een compile", is to issue the )ollo1ing comman"M
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+an$+$rac/..ar

This 1ill simply repac.age the =$rac/..ar= )ile )rom the pre-,uilt source mo"ules, an" change" runtime con)iguration )iles. I) e!erything has alrea"y ,een compile", this comman" typically ta.es only a )e1 secon"s to complete.

OpenGTS Configuration and Installation Manual

Page 18 of 61

Install the create" =$rac/..ar= )ile per the pache Tomcat installation#con)iguration instructions. Typically, this means copying the =$rac/..ar= )ile to the "irectory =$7ATA,8NA_HOME/.e#apps/.=M
/usr/local/!pen"TS#$%&%'>+cp+#u)l(/$rac/..ar+$7ATA,8NA_HOME/.e#apps/. Er, the )ollo1ing =ant= target may also ,e use"M /usr/local/!pen"TS#$%&%'>+an$+$rac/.(eplo&

The a,o!e metho" )or "eployment assumes that Tomcat is set )or *au$oOeplo&!<$rue=*. I) your changes to not appear a)ter re,uil"ing an" re"eploying the =$rac/..ar= )ile, then it may ,e necessary to )orce Tomcat to up"ate the =$rac/..ar= ser!let ,y )ollo1ing these stepsM Stop Tomcat Hie. =$7ATA,8NA_HOME/#)n/s6u$(o.n.s6=I 'elete the e7isting =$rac/= ser!let Hie. =r +-r0+$7ATA,8NA_HOME/.e#apps/$rac/:=I 'eploy the ne1 =$rac/= ser!let Hie. =cp+$GTS_HOME/#u)l(/$rac/..ar+$7ATA,8NA_HOME/.e#apps/.=I %estart Tomcat Hie. =$7ATA,8NA_HOME/#)n/s$ar$up.s6=I - -E Testing the Installation - - aE Secure 7e/ access: Con)iguration an" use o) *4ttps* Hie. SS5I is highly recommen"e" as the +%5 inclu"es the account pass1or" an" 1ill ,e encrypte" !ia *6$$ps*, ,ut 1ill ,e sent in the clear i) plain *6$$p* is use". Instructions )or con)iguring Tomcat to support SS5 can ,e )oun" on the pache Tomcat 1e,site. )ter ,uil"ing#"eploying *$rac/..ar*, you shoul" ,e a,le to !ie1 the login page 1ith a +%5 similar to the )ollo1ingM 6$$p=//local6os$=R2R2/$rac//Trac/ Hreplace =*local6os$=R2R2= 1ith your o1n "omain name 1here *$rac/..ar* 1as installe".I Jote that the speci)ication )or the +%5 "irectory =/$rac//Trac/= is case sensiti!e. Support )or re!erse-geoco"ing Hturning a latitu"e#longitu"e into an a""ressI, using ser!ices such as Geonames HhttpM##geonames.orgI an" Google, has also ,een inclu"e". 5oo. )or the =5e-erseGeo6o2e7ro-'2er= tags in the *pr)"a$e.5 l* )ile )or more in)ormation. - - /E ,ro7ser Co"pati/ilit$: The G6S trac.ing map page in the 1e, inter)ace ma.es hea!y use o) ;a!aScript an" NT&5 )ormatting. (ire)o7 !3.9.9, Chrome 8.0.9, an" Sa)ari $.0.9, are the plat)orms targete", ,ut it also appears to 1or. )ine H1ith some minor "i))erencesI on &icroso)t I3 /.0#7.0#8.0 Hsome !isual anomalies ha!e ,een reporte" 1ith earlier !ersions o) I3I. Ether ,ro1sers ha!e not ,een )ully teste".

- 0E Installing Multiple 3ersions of +trac6 7ar+ The +%5 )or accessing the login page is normally as )ollo1sM 6$$p=//local6os$=R2R2/tr,68/Trac/ The name =tr,68= liste" a,o!e "eri!es it*s name )rom the name )or the 1ar )ile, in this case =tr,68..ar=. This means that you can install multiple#"i))erent copies o) the =tr,68..ar= )ile, as long as the name o) the 1ar )ile is change" "uring the copy. (or instance, i) you copy the =tr,68..ar= )ile to Tomcat as )ollo1sM
/usr/local/!pen"TS#$%&%'>+cp+#u)l(/tr,68..ar+$7ATA,8NA_HOME/.e#apps/tr,681..ar Then you coul" access this installe" !ersion 1ith the )ollo1ing +%5M

6$$p=//local6os$=R2R2/tr,681/Trac/
OpenGTS Configuration and Installation Manual

Page 19 of 61

0E Installing 5events 7ar8


The =e"en$s..ar= HIe,-ARchi!eI runs in a ;a!a Ser!let container an" 1or.s 1ith the S45 '< "atastore to allo1 "o1nloa"ing selecte" portions o) a se?uence o) e!ents o!er the 1e,. This can ,e use" 1ith 1e,-,ase" mapping applications to pro!i"e near real-time trac.ing o) a !ehicle or person. The *=e"en$s..ar= ser!let currently supports "ata retrie!al in D&5, 9&5, CS2, T9T, G69, or ;SEJ )ile )ormats, an" can ,e use" in mapping programs such as Google 3arth, or &S &ap6oints. 0 1E Configuring the +7e/app conf+ 4ile The "e)ault runtime con)iguration )ile =.e#app.con0= inclu"es the )ile =co on.con0=, 1hich in-turn inclu"es =s&s$e .con0= an" =cus$o .con0=. (or most installations, the "e)ault !alues speci)ie" in this )ile can ,e le)t as-is. No1e!er, some items, such as your S&T6 ser!er speci)ications, shoul" ,e con)igure" to )it your system re?uirements. Shoul" you 1ish to customiAe the =.e#app.con0= )ile speci)ically )or the =e"en$s..ar= ser!let, copy this )ile to the "irectory =$GTS_HOME/.ar/e"en$s/@E;-8N-/= an" mo"i)y this copy. 0 #E Co"piling/Installing the +events 7ar+ *ava Servlet To ,uil" the =e"en$s..ar= )ile, run the nt ,uil" comman" as )ollo1sM /zzz>+c(+$GTS_HOME
/usr/local/!pen"TS#$%&%'>+an$+e"en$s
Hnote, the = an$+all= per)orme" a,o!e also ,uil"s the = e"en$s..ar= )ileI

The target =e"en$s= is a 1rapper )or ant targets =e"en$s.co p)le= an" =e"en$s..ar=. The target =e"en$s.co p)le= compiles all necessary classes an" con)iguration )iles into the ,uil" "irectory =$GTS_HOME/#u)l(/e"en$s=. The target =e"en$s..ar= then creates the *1e, archi!e* )ile =$GTS_HOME/#u)l(/e"en$s..ar=. Install the =e"en$s..ar= )ile per the pache Tomcat installation#con)iguration instructions. Typically, this simply in!ol!es copying the =e"en$s..ar= )ile to the "irectory =$7ATA,8NA_HOME/.e#apps/.=. HThe a,o!e metho" )or "eployment assumes that Tomcat is set )or *au$oOeplo&!<$rue=*I 0 %E Testing the Installation ccess the "ata store" in the S45 '< !ia the 1e, 1ith the )ollo1ing constructe" +%5M +++++6$$p's*=//local6os$=R2R2/e"en$s/%0)leM.>/ lS5 lScs"S$5$Sgp5S4son?T +++++++++++a'ccoun$*!%accoun$M++++-+$6e+accoun$+na e ++++++++++Uu'ser*!%userM++++++++++-+$6e+user+na e ++++++++++Up'ass.or(*!%pass.or(M++-+$6e+accoun$/user+pass.or( ++++++++++U('e")ce*!%(e")ceM++++++-+$6e+(e")ce+na e ++++++++++Ug'roup*!%groupM++++++++-+$6e+(e")ce+group+na e+Vop$)onalW ++++++++++'Ur0!%0ro T) eM*++++++++-+op$)onal+Q0ro Q+(a$a+range. ++++++++++'Ur$!%$oT) eM*++++++++++-+op$)onal+Q$oQ+(a$a+range. ++++++++++'Ul') )$*!%l) )$M*++++++-+op$)onal+Ql) )$Q+nu #er+o0+re$urne(+e"en$s. 0here =local6os$=R2R2= shoul" ,e replace" 1ith the actual "omain name an" port use" to access the pache Tomcat 1e, ser!er. SJoteM a,o!e items place" in s?uare-,rac.ets are optional. The options place" in curly ,races in"icate that one o) the options 1ithin the curly ,races shoul" ,e selecte"T.

OpenGTS Configuration and Installation Manual

Page 20 of 61

JoteM The *r0* an" *r$* "ate ranges may ,e speci)ie" in *+ni7 3poch* time )ormat Hnum,er o) secon"s since mi"night ;an 1 1:70I or in =&&&&/ /((/HH=MM=SS= )ormat. I) not speci)ie", the last 100 e!ents 1ill ,e returne". 0 % aE ?ote regarding secure 7e/ access: Con)iguration an" use o) *4ttps* Hie. SS5I is highly recommen"e" as the +%5 inclu"es the account pass1or" an" 1ill ,e encrypte" !ia *6$$ps*, ,ut 1ill ,e sent in the clear i) plain *6$$p* is use". Instructions )or con)iguring Tomcat to support SS5 can ,e )oun" on the pache Tomcat 1e,site.

So"e e>a"ples:
6$$ps=//local6os$=R2R2/e"en$s/(a$a.cs"Ta!open( $pUp! &passU(! o#)le

Return a CSV formatted data file (' (a$a.cs"' !ontaining t"e la#t 100 e$ent re!ord for t"e de$i!e 'opendmtp'%'mobile'& '"e data i# returned $ia an "tt( SS) !onne!tion& (*ote+ re(la!e ' mypass' ,it" t"e (ro(er (a##,ord
6$$p=//local6os$=R2R2/e"en$s/(a$a.4sonTa!(e oUp! &passU(!(e o

Return a -S.* formatted data file (' (a$a.4son' !ontaining t"e la#t 100 e$ent re!ord for t"e de$i!e 'demo'%'demo'& (*ote+ re(la!e 'mypass' ,it" t"e (ro(er (a##,ord
6$$p=//local6os$=R2R2/e"en$s/(a$a./ lTa!g$sUp! &passU(!(e"Ur0!11FEXX1222Ur$!11FEXXX222

Return a /0) (10) fomatted data file (' (a$a./ l' ,it" t"e fir#t 100 e$ent# ,it"in t"e #(e!ified range for t"e de$i!e 2gt#%de$2&
6$$p=//local6os$=R2R2/e"en$s/(a$a.gp5Ta!g$sUp! &passU(!(e"Ur0!11FEXX1222Ur$!11FEXXX222

Return a 3P1 (10) fomatted data file (' (a$a.gp5' ,it" t"e fir#t 100 e$ent# ,it"in t"e #(e!ified range for t"e de$i!e 2gt#%de$2 (#ee 2"tt(+%%,,,&to(ografi4&!om%g(4&a#(2 for information regarding t"e 3P1 data format & 3oogle 5art" "a# t"e !a(a6ilit7 of automati!all7 (olling data from t"i# 8R) at #(e!ified inter$al#& 'o !onfigure 3oogle 5art" to read e$ent data (oint# from t"e #er$er9 !li!: on 2;dd2 on t"e main menu 6ar9 t"en #ele!t 2*et,or: )in:2& ;dd t"e /0) retrie$al 8R) to t"e #er$er and !li!: 2Refre#" Parameter#2 to 6e a6le to enter (eriodi! refre#" time#& 'o al,a7# di#(la7 t"e mo#t re!ent e$ent# ,it"in 3oogle 5art"9 omit t"e date range o(tion (2r02 and 2r$2 and in#tead #(e!if7 t"e o(tion 2l) )$2 to !au#e t"e returned li#t to al,a7# in!lude t"e late#t #et of e$ent#&
6$$p=//local6os$=R2R2/e"en$s/(a$a./ lTa!g$sUp! &passU(!(e"Ul) )$!122

Return a /0) (10) fomatted data file (' (a$a./ l' ,it" t"e la#t 100 a$aila6le e$ent# for t"e de$i!e 2gt#%de$2&
6$$p=//local6os$=R2R2/e"en$s/(a$a./ lTa!g$sUp! &passU(!(e"Ul) )$!1

Return a /0) (10) fomatted data file (' (a$a./ l' ,it" onl7 t"e la#t (mo#t re!ent e$ent for t"e de$i!e 2gt#%de$2&

OpenGTS Configuration and Installation Manual

Page 21 of 61

9E Data/ase Ad"inistration
9 aE I"portant note regarding + sh+ and + /at+ co""and files: Comman"s en"ing 1ith =.sh= or =.,at= M1ST ,e e7ecute" )rom the OpenGTS installation "irectory. ttempting to e7ecute these comman"s )rom another "irectory may result in a =ClassJot(oun"37ception= or =JoClass'e)(oun"3rror= error, or similar. HThis means that you must c" to JGTSHBOM&, then e7ecute the comman" as =#)n/%comman+M=I 9 /E I"portant note for Iindo7s users: 0hen using the =.#a$= !ersion o) the comman"s in a 'ES 1in"o1, comman" arguments such as -rootUser=root must either ,e enclose" in ?uotes, as in "-rootUser=root", or ,e speci)ie" 1ith a colon instea" o) an e?ual sign, as in -rootUser:root .

&ost "ata,ase a"ministration H ccount, +ser, an" 'e!ice, etcI can ,e per)orme" through either the comman"-line utilities or through the 1e,-inter)ace. The e7ample ccount#+ser#'e!ice e"iting e7amples sho1n ,elo1 "escri,e only a )e1 o) the possi,le )iel"s in each o) these ta,les. The )ile *S7HEMA.$5$*, inclu"e" 1ith the OpenGTS pac.age, contains a list o) the current ta,les, an" the )iel"s in each o) the a!aila,le ta,les. list o) the currently "e)ine" ta,les an" )iel"s can also ,e generate" 1ith the )ollo1ing comman"M
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-sc6e a

Er, on 0in"o1sM
C-.zzz>+c(+%GTS_HOME% C-.!pen"TS#$%&%'>+#)nH(#A7on0)g.#a$+-sc6e a

9 1E Creating/&diting Accounts The comman" =#)n/a( )n.s6+Accoun$= supports many a"ministrati!e )unction 1hich act on the S45 =Accoun$= ta,le. Nere are a )e1 o) the )unctions that can ,e per)orme" using the =#)n/a( )n.s6+Accoun$= comman"M Creating an Account:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Accoun$+-accoun$!%acc$M+-crea$e

This creates the speci)ie" ccount 1ith "e)ault !alues Hreplace =%acc$M= 1ith the account i" you 1ish to createI. &diting an Account:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Accoun$+-accoun$!%acc$M+-e()$

This comman" "isplays a comman"-line ccount )iel" e"itor, similar to the )ollo1ingM

OpenGTS Configuration and Installation Manual

Page 22 of 61

*N()+# )he "ollo&ing is only an e,ample- .our implementation &ill !ontain addtional "ield de"initions- /lease revie& the "ile 0 1H+M2-t,t0 in the (pen3) pa!kage "or a list o" possi$le "ield de"initions-4 ----------------------------------------Pe&=+open( $p ----------------------------------------+2W+Aass.or(++++++++++++++++++++++++++++=+<(e o< +1W+Oescr)p$)on+++++++++++++++++++++++++=+<E5a ple+Accoun$< +2W+8s+Ac$)"e+++++++++++++++++++++++++++=+<$rue< +3W+7on$ac$+Na e++++++++++++++++++++++++=+<< +FW+7on$ac$+A6one+++++++++++++++++++++++=+<< +EW+7on$ac$+EMa)l+A((ress+++++++++++++++=+<< +1W+T) e+Yone+++++++++++++++++++++++++++=+<LS/Ha.a))< +XW+Spee(+Ln)$s+++++++++++++++++++++++++=+<2< +RW+O)s$ance+Ln)$s++++++++++++++++++++++=+<2< +ZW+Geoco(er+ o(e+++++++++++++++++++++++=+<2< 12W+Ar)"a$e,a#el+Na e+++++++++++++++++++=+<:< En$er+0)el(+nu #er+'or+Qsa"eQBQe5)$Q*= To select a )iel" !alue to change, enter the )iel" num,er, then hit enter. again. Sa!e your changes ,y )inally entering =sa!e=. )ter changing the !alue o) the )iel", hit enter

Nere is a "escription o) a )e1 o) the ccount )iel"s %please see 'SCH/M0%t1t' or a description o other possible ield de initions&M !ass7ord L The ccount login pass1or". 0hen logging in, i) the user =a"min= e7ists, then the =a"min= pass1or" 1ill ,e use", instea" o) this pass1or", to authenticate the user. Description L The ccount "escription Huse" on reports, etcI. Is Active L This !alue is =true= i) the ccount is still consi"ere" in-ser!ice. I) =)alse=, then all connections ,y all o1ne" "e!ices 1ill ,e re)use". Contact ?a"e L The name o) the contact person )or the ccount. Contact !hone L The contact person*s phone num,er. Contact &"ail Address L The contact person*s email a""res. Ti"e Lone L The pre)erre" timeAone )or the ccount. Speed 1nits L The pre)erre" spee" units )or the ccount. 2ali" !alues areM 0Wmph, 1W.ph, 2W.nots. Distance 1nits L The pre)erre" "istance units )or the ccount. 2alue !alues areM 0W&iles, 1WDilometers, 2WDnots. Geocoder "ode L This is the re!erse-geoco"ing mo"e use" )or this ccount. 2ali" !alues areM 0WJo re!ersegeoco"ing per)orme", 1WGeoAone loo.up only, 2W%e!erse-geoco"ing )or high-priority status co"es only, 3W%e!erse-geoco"e e!erything Han a!aila,le re!erse-geoco"ing ser!ice is re?uire"I. !rivate(a/el ?a"e L This is the name o) the *Oo a)n* in the *pr)"a$e.5 l* )ile to 1hich this account shoul" ,e assigne". I) there is more than one *Oo a)n* "e)ine" in the *pr)"a$e.5 l* )ile, then this allo1s )or using "i))erent re!erse-geoco"ing, an" mapping resources )or "i))erent accounts. (isting e>isting Accounts:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Accoun$+-l)s$

This lists all ccounts an" o1ne" 'e!ices.

OpenGTS Configuration and Installation Manual

Page 23 of 61

9 #E Creating/&diting 1sers The comman" =#)n/a( )n.s6+Lser= supports se!eral a"ministrati!e )unctions 1hich act on the S45 =Lser= ta,le. Nere are a )e1 o) the )unctions that can ,e per)orme" using the =#)n/a( )n.s6+Lser= comman"M Creating a 1ser:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Lser+-accoun$!%acc$M+-user!%userM+-crea$e

This creates the speci)ie" +ser 1ith "e)ault !alues Hreplace =%userM= 1ith the user i" you 1ish to createI. The user name =a( )n= is reser!e" )or use ,y the ccount a"ministrator. 0hen the ccount a"ministrator logs in H,y lea!ing the user name )iel" ,lan. on the log in screenI, then the log in process 1ill chec. to see i) the user =a( )n= e7ists. I) this user name "oes e7ist, then the pass1or" an" access-control assigne" to the =a"min= user 1ill ,e use" )or the ccount a"ministrator HJoteM the "e)ault login user can ,e change" on the ccount "min 1e, page, or on the ccount comman"-line e"itI. &diting a 1ser:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Lser+-accoun$!%acc$M+-user!%userM+-e()$

This comman" "isplays a comman"-line +ser )iel" e"itor, similar to the )ollo1ingM *N()+# )he "ollo&ing is only an e,ample- .our implementation &ill !ontain addtional "ield de"initions- /lease revie& the "ile 0SCHEMA.txt0 in the (pen3) pa!kage "or a list o" possi$le "ield de"initions-4 ----------------------------------------Pe&=+open( $pBuser ----------------------------------------+2W+Aass.or(++++++++++++++++++++++++++++=+<< +1W+Oescr)p$)on+++++++++++++++++++++++++=+<Ne.+Lser< +2W+8s+Ac$)"e+++++++++++++++++++++++++++=+<$rue< +3W+7on$ac$+Na e++++++++++++++++++++++++=+<< +FW+7on$ac$+A6one+++++++++++++++++++++++=+<< +EW+7on$ac$+EMa)l+A((ress+++++++++++++++=+<< +1W+T) e+Yone+++++++++++++++++++++++++++=+<< En$er+0)el(+nu #er+'or+Qsa"eQBQe5)$Q* To select a )iel" !alue to change, enter the )iel" num,er, then hit enter. again. Sa!e your changes ,y )inally entering =sa!e=. )ter changing the !alue o) the )iel", hit enter

Nere is a "etaile" "escription o) a )e1 o) the +ser )iel"s %please see $SCH/M0%t1t= or a description o other possible ield de initions&M !ass7ord L The +ser login pass1or". 5ea!ing the pass1or" )ile empty 1ill pre!ent the user )rom logging in. I) you 1ish to allo1 the user to log in 1ithout ha!ing to enter a pass1or", then you must set the pass1or" )iel" to the test =9(&,n89= Hcase insensiti!e, an" 1ithout the ?uotes o) courseI. Description L The +ser "escription Huse" on reports, etcI. Is Active L This !alue is =true= i) the +ser is still consi"ere" in-ser!ice. I) =)alse=, then all login attempts ,y this +ser 1ill ,e re)use". Contact ?a"e L The name o) the contact person )or the +ser. Contact !hone L The contact person*s phone num,er. Contact &"ail Address L The contact person*s email a""res. Ti"e Lone L The pre)erre" timeAone )or the +ser

OpenGTS Configuration and Installation Manual

Page 24 of 61

9 %E Creating/&diting Devices The comman" =#)n/a( )n.s6+Oe")ce= supports many a"ministrati!e )unctions 1hich act on the S45 =Oe")ce= ta,le. Nere are a )e1 o) the )unctions that can ,e per)orme" using the =#)n/a( )n.s6+Oe")ce= comman"M Creating a Device:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Oe")ce+-accoun$!%acc$M+-(e")ce!%(e"M+-crea$e

This creates the speci)ie" 'e!ice 1ith "e)ault !alues Hreplace =%(e"M= 1ith the "e!ice i" you 1ish to createI. &diting a Device:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Oe")ce+-accoun$!%acc$M+-(e")ce!%(e"M+-e()$

This comman" "isplays a comman"-line +ser )iel" e"itor, similar to the )ollo1ingM *N()+# )he "ollo&ing is only an e,ample- .our implementation &ill !ontain addtional "ield de"initions- /lease revie& the "ile "SCHEMA.txt+ in the (pen3) pa!kage "or a list o" possi$le "ield de"initions-4 ----------------------------------------Pe&=+open( $pB o#)le ----------------------------------------+2W+Oescr)p$)on+++++++++++++++++++++++++=+<Ne.+Oe")ce< +1W+8s+Ac$)"e+++++++++++++++++++++++++++=+<$rue< +2W+Val)(+8A+A((resses++++++++++++++++++=+<< +3W+Suppor$e(+Enco()ngs+++++++++++++++++=+<X< +FW+Accoun$)ng+T) e+8n$er"al+M)nu$es++++=+<12< +EW+Ma5+E"en$s+per+8n$er"al+++++++++++++=+<21< +1W+Ma5+To$al+7onnec$)ons+per+8n$er"al++=+<12< +XW+Ma5+To$al+7onnec$)ons+per+M)nu$e++++=+<2< +RW+Ma5+Ouple5+7onnec$)ons+per+8n$er"al+=+<1< +ZW+Ma5+Ouple5+7onnec$)ons+per+M)nu$e+++=+<1< En$er+0)el(+nu #er+'or+Qsa"eQBQe5)$Q*= To select a )iel" !alue to change, enter the )iel" num,er, then hit enter. again. Sa!e your changes ,y )inally entering =sa!e=. )ter changing the !alue o) the )iel", hit enter

Nere is a "etaile" "escription o) a )e1 o) the 'e!ice )iel"s %please see $SCH/M0%t1t$ or a description o other possible ield de initions&M Description L The "escription o) the "e!ice Huse" on reports, etcI. Is Active L =true= i) this "e!ice is consi"ere" still in-ser!ice. I) =)alse=, all connections )rom this "e!ice 1ill ,e re)use". 3alid I! Addresses L The I6 ""ress ,y the 'e!ice on an incoming connection is chec.e" against this speci)ie" ,loc. o) !ali" I6 a""resses, an" re)use" i) the I6 a""ress "oes not match. ,lan. !alue accepts all incoming I6 a""resses. Supported &ncodings L This is an OpenDMT! protocol parameters, an" shoul" generally al1ays ,e =7=. See the Epen'&T6 protocol speci)ication )or more in)ormation. Accounting Ti"e Interval Minutes L HOpenDMT! onlyI This !alue is use" to pre!ent runa1ay clients )rom consuming too much ,an"1i"th. The !alue here speci)ies the num,er o) minutes o!er 1hich the )ollo1ing =&a7= !alue limits are impose". !alue o) =0= "isa,les connection accounting. Ma> &vents per Interval L HOpenDMT! onlyI The ma7imum num,er o) e!ents allo1e" "uring the a,o!e speci)ie" inter!al. Ma> Total Connections per Interval L HOpenDMT! onlyI This is the ma7imum num,er o) TC6 or +'6 connections that are allo1e" "uring the a,o!e speci)ie" inter!al.

OpenGTS Configuration and Installation Manual

Page 25 of 61

Ma> Total Connections per Minute L HOpenDMT! onlyI This is the ma7imum num,er o) TC6 or +'6 connections that are allo1e" "uring a /0 secon" inter!al. Ma> Duple> Connections per Interval L HOpenDMT! onlyI This is the ma7imum num,er o) TC6 connections that are allo1e" "uring the a,o!e speci)ie" inter!al. Ma> Duple> Connections per Minute L HOpenDMT! onlyI This is the ma7imum num,er o) TC6 connections that are allo1e" "uring a /0 secon" inter!al. Retrieving Device &vents through the co""andCline:
/usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Oe")ce+-accoun$!%acc$M+-(e")ce!%(e"M+-e"en$s

This comman" returns the last )e1 e!ents in CS2 )ormat.


Oa$eBT) eB7o(eB,a$)$u(eB,ong)$u(eBSpee(BHea()ngBAl$)$u(eBA((ress 222X/23/2XB23=13=21B8nMo$)onB2Z.EX2F1B-1F2.XRR1ZB123.ZB1XR.3B2RX.2B<< 222X/23/2XB23=1E=23B8nMo$)onB2Z.EX2F1B-1F2.XRR1ZB123.ZB1XR.3B2RX.2B<< 222X/23/2XB23=1X=23B8nMo$)onB2Z.EX2F1B-1F2.XRR1ZB123.ZB1XR.3B2RX.2B<< 222X/23/2XB23=1Z=23B8nMo$)onB2Z.EX2F1B-1F2.XRR1ZB123.ZB1XR.3B2RX.2B<< 222X/23/2XB23=21=2EB8nMo$)onB2Z.EX2F1B-1F2.XRR1ZB123.ZB1XR.3B2RX.2B<< 222X/23/2XB23=23=2XB8nMo$)onB2Z.EX2F1B-1F2.XRR1ZB123.ZB1XR.3B2RX.2B<<

Deleting +4uture+ &vents for a given Device: Eccasionally a G6S trac.ing "e!ice 1ill emit a G6S "ate#time 1hich is in the )uture, sometimes a long time into the )uture. To "isplay the num,er o) current e!ents 1hich are more than $ minutes into the )uture, enter the )ollo1ing comman"M ...>+#)n/a( )n.s6+Oe")ce+-accoun$!%acc$M+-(e")ce!%(e"M+-coun$-u$ureE"en$s!322 To "elete these *)uture* e!entsM ...>+#)n/a( )n.s6+Oe")ce+-accoun$!%acc$M+-(e")ce!%(e"M+-(ele$e-u$ureE"en$s!322 Deleting +old+ &vents for a given Device: s e!ents collect in the "ata,ase, it may ,e han"y at some point to trim ol" e!ents )rom the system. The )ollo1ing comman" 1ill count the num,er o) e!ents prior to :0 "ay agoM ...>+#)n/a( )n.s6+Oe")ce+-accoun$!%acc$M+-(e")ce!%(e"M+-coun$Ol(E"en$s!-Z2( To "elete these =ol"= e!entsM ...>+#)n/a( )n.s6+Oe")ce+-accoun$!%acc$M+-(e")ce!%(e"M+-(ele$eOl(E"en$s!-Z2( The arguement !alue )or the =coun$Ol(E"en$s= an" =(ele$eOl(E"en$s= can ,e speci)ie" using a relati!e time, such as =-122(=, in"icating e!ents ol"er than 120 "ays ago, or 1ith a speci)ic time speci)ication, such as =2212/23/12B13=1E=22BGMT= in"icating e!ents e7isting ,e)ore &arch 12, 2010 1M1$pm G&T. IAR?I?G: Deleting old events fro" the &ventData ta/le is final Once the events have /een deleted; the$ cannot /e recovered

OpenGTS Configuration and Installation Manual

Page 26 of 61

9 'E General Data/ase Ad"inistrative 4unctions The comman" =(#A( )n.pl= Honly a!aila,le as a 6erl scriptI can per)orm !arious a"ministrati!e )unctions on the S45 "ata,ase HJoteM the comman" *#)nH(#7on0)g.#a$* is pro!i"e" )or 0in"o1s users, an" per)orms a su,set o) the operations a!aila,le to the =(#A( )n.pl= comman"I. Nere are a )e1 o) the )unctions that can ,e per)orme" using the =(#A( )n.pl= comman"M 3erif$/1pdate ta/le colu"ns:
/usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-$a#les

This comman" 1ill chec. the column con)iguration o) all OpenGTS ta,les an" report on any missing columns, or other anomolies. I) an OpenGTS ta,le "oes not e7ist, it 1ill ,e create".
/usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-$a#les!c

0hen upgra"ing to a ne1er !ersion o) OpenGTS in 1hich ne1 columns ha!e ,een a""e" to !arious ta,les, the a,o!e comman" 1ill issue the re?uire" =A,TEI+TA;,E= comman"s to the ta,les as re?uire" in or"er to a"" any ne1 ta,le columns. I) a speci)ic column *type* has change", using =-$a#les!ca= 1ill cause column types to ,e altere".
/usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-$a#les!ca

Er, on 0in"o1sM
C-.!pen"TS#$%&%'>+#)nH(#7on0)g.#a$+-$a#les=ca

This comman" shoul" ,e use" 1hene!er upgra"ing to a ne1er !ersion o) OpenGTS. Du"p ta/les to dis6:
/usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-(u p+-()r!/$ p/g$s

This comman" 1ill "ump all OpenGTS ta,les to the "irectory speci)ie" ,y the =-()r= argument H=/$ p/g$s= is the "e)ault "estination i) the =-()r= option is not speci)ie"I. I) re?uire" ,y your &yS45 installation, you may also nee" to speci)y the "ata,ase root user Hie. as in =-roo$Lser!%userM=I. In"i!i"ual ta,les can then later ,e reloa"e" 1ith the =-loa(!%$a#leM= option. HJote )or 5inu7 usersM En some !ersions o) 5inu7 1hich employ S35inu7, you may recei!e an error in"icating that &yS45 is not allo1e" to 1rite into the speci)ie" "irectory. In these cases, you may nee" to either speci)y a "irectory that &yS45 is allo1e" to 1rite to, or change the S35inu7 security settings to pro!i"e &yS45 1ith authoriAation to 1rite to the =/$ p= "irectory.I (oad ta/les fro" Dis6:
/usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-loa(!(ta2le>+-()r!/$ p/g$s

This comman" 1ill loa" the speci)ie" ta,le )rom the )ile pre!iously create" ,y the =-(u p= argument. 'uring the ta,le loa", columns are matche" 1here possi,le. I) a column is present in the *"umpe"* )ile, ,ut has ,een remo!e" in the current GTS ta,le, a 1arning 1ill ,e generate" that the column has ,een "roppe". This comman" is use)ul 1hen small ta,le changes nee" to ,e ma"e in the column structure. SJoteM the s?uare ,rac.ets speci)ie" a,o!e in"icate that the option 1ithin the ,rac.ets is optional. The s?uare ,rac.ets shoul" not ,e speci)ie" literally on the comman"-line i) the optional argument 1ithin the ,rac.ets is use"T.

OpenGTS Configuration and Installation Manual

Page 27 of 61

:E Installing/Starting the OpenDMT!; T<1=>; and Aspicore DCS Modules


This section "escri,es ho1 to start an" stop the =g$s( $p=, =$/125=, an" =asp)core= "e!ice communication ser!er H'CSI mo"ules, ho1e!er these instructions are also applica,le to other "e!ice communication ser!ers 1hich may also ,e installe" or implemente". &ore in)ormation on the OpenDMT! proGect may ,e )oun" at the lin. =httpM##111.open"mtp.org=. Support )or OpenDMT! compliant "e!ices is inclu"e" in OpenGTS 1ith the =g$s( $p= "e!ice communication ser!er H'CSI. The =$/125= 'CS mo"ule supports most common TD102#TD103 protocol compliant "e!ices HJoteM some manu)acturers pro"ucing a TD102#TD103 "e!ice may ,e using their o1n custom protocol !ariant that is not compati,le 1ith the common TD102#TD103 protocolI. Aspicore pro!i"es client phone so)t1are )or trac.ing !arious Jo.ia, Samsung, an" Sony 3ricsson phones. The spicore 'CS 1ithin the EpenGTS pac.age is "esigne" to 1or. 1ith the TC6 or +'6 "ata transport metho" 1hich can ,e con)igure" 1ithin the spicore client phone application. (or more in)ormation on their supporte" phones, an" to o,tain their client so)t1are, !istit their 1e,site at =httpM##111.aspicore.com#en#tuotteet>trac.er.aspKta,W2Xsu,W1=. : 1E Configuring the +dcservers >"l+ 4ile The )ile =(cser"ers.5 l= contains a )e1 con)igura,le properties that e))ect the e7ecution o) the OpenDMT! H=g$s( $p=I an" Aspicore H=asp)core=I ser!ers. &ost o) the properties !alues shoul" ,e le)t as their "e)ault !alue, ,ut the )ollo1ing properties !alues can ,e set to those appropriate to your operating en!ironmentM OpenDMT!M $cpAor$!<31222< u(pAor$!<31222< T<1=FM

$cpAor$!<312X2< u(pAor$!<312X2<

AspicoreM $cpAor$!<3121E< u(pAor$!<3121E< These ports are speci)ie" on the =,)s$enAor$s= tag )or their respecti!e =O7Ser"er=, an" are the "e)ault ports on 1hich these ser!ers listen )or incoming connections )rom the remote "e!ices. Oou can change this port ,y changing the !alue on this tag attri,ute. Oou can also in"icate multiple ports ,y speci)ying them 1ith comma separators. Hie. *$cpAor$!<31222B31122<*I. : #E Starting the Device Co""unication Server The =g$s( $p=, =$/125=, or =asp)core= ser!er can ,e starte" as )ollo1sM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+#)n/runser"er.s6+-s+server

0here =server= shoul" ,e replace" 1ith the speci)ic name o) the ser!er to start Hie. =g$s( $p=, =$/125=, or =asp)core=I.

OpenGTS Configuration and Installation Manual

Page 28 of 61

: #aE I"portant note regarding + sh+ and + /at+ co""and files: Comman"s en"ing 1ith =.s6= or =.#a$= &+ST ,e e7ecute" )rom the OpenGTS installation "irectory. ttempting to e7ecute these comman"s )rom another "irectory may result in a =ClassJot(oun"37ception= or =JoClass'e)(oun"3rror= error, or similar. HThis means that you must c" to JGTSHBOM&, then e7ecute the comman" as =#)n/%comman+M=I Er, the 6erl !ersion o) this comman" can ,e use" 1ithout nee"ing to ,e in the OpenGTS installation "irectoryM
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+server

En 0in"o1s, the comman" can omit the =-s= an" can ,e entere" as )ollo1sM
C-.>+c(+HOpenGTS_1.2.3 C-.!pen"TS#$%&%'.>+H#)nHrunser"er.#a$+server

The ser!er 1ill initialiAe an" start listening on the portHsI speci)ie" ,y the =,)s$enAor$s= tag in the =(cser"ers.5 l= )ile )or the speci)ic name" 'CSer!er. To change the listen port on the comman" line, you can a"" a =-por$= argument as )ollo1sM
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+server+-por$+31123

Er on 0in"o1sM
C-.!pen"TS#$%&%'.>+H#)nHrunser"er.#a$+server+-por$=31123

To set listening on port =31123=. Oou can also a"" the comman"-line option =-(e#ugMo(e= to ena,le "e,ug-le!el logging. 0hile running in =,ac.groun"= mo"e, the output logs are store" in the )ile =$GTS_HOME/logs/server.log=. HThe )ile =server.ou$= is also create" ,y =runser"er.pl= to capture output to st"out#st"err, ,ut 1ill typically remain emptyI. 0hen testing#"e,ugging, you may also start a ser!er =interacti!ely=. That is, the ser!er is run in the )oregroun" Hie. not *,ac.groun"e"*I, an" all logging output is sent to the console instea" o) the log )ile. To start a ser!er =interacti!ely=, a"" the option =-)= to the comman" line, as )ollo1sM
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+server+-)

HTo stop the ser!er in this mo"e, simply press *Control-C*I : %E Stopping the Device Co""unication Server 0hen starte" in =,ac.groun"= mo"e Hie. 0ithout the =-)= optionI, a =6rocess I'= H6I'I )ile is create" at =$GTS_HOME/logs/server.p)(=, 1hich contains the process-i" o) the ,ac.groun"e" tas.. This )ile is use" to stop the ser!er 1ith the comman"M
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+server+-/)ll

0here =server= shoul" ,e replace" 1ith the speci)ic name o) the ser!er to start Hie. =g$s( $p=, =$/125=, or =asp)core=I.

OpenGTS Configuration and Installation Manual

Page 29 of 61

En 5inu7 systems, the 6erl comman" =ps4a"a=, inclu"e" 1ith OpenGTS, can ,e use" to "isplay in)ormation regar"ing 1hich 'e!ice Communication Ser!ers are currently runningrM
/zzz>+$GTS_HOME/#)n/ps4a"a ++A8O++Aaren$++,+Lser+++++Ja"a+class/4ar ------+------++-+--------+------------------------------------------------------+++21EV+++++1W+1+openg$s++org.apac6e.ca$al)na.s$ar$up.;oo$s$rap++ ++R11EV+++++1W+1+openg$s++/usr/local/OpenGTS_1.2.3/#u)l(/l)#/g$s( $p.4ar++ ++R122V+++++1W+1+openg$s++/usr/local/OpenGTS_1.2.3/#u)l(/l)#/$/125.4ar++ ++R123V+++++1W+1+openg$s++/usr/local/OpenGTS_1.2.3/#u)l(/l)#/asp)core.4ar++ ++R12ZV+++++1W+1+openg$s++/usr/local/OpenGTS_1.2.3/#u)l(/l)#/$e pla$e.4ar++

This comman" lists all .no1n running ;a!a processes, 1ith their associate" 6I' Hprocess-i"I, parent 6I', user, an" ;a!a class or Gar )ile 1hich is currently running. The =org.apac6e.ca$al)na.s$ar$up.;oo$s$rap= process in"icates that pache Tomcat is running 1ith the in"icate" 6I'. =g$s( $p=, =$/125=, =asp)core=, an" =$e pla$e= in"icate their respecti!e running 'e!ice Communication Ser!ers. : 'E Adding a ?e7 Device Record Ence the proper "e!ice communication ser!er H'CSI is running, login to an account you 1ish to ha!e o1n the "e!ice#phone you 1ill ,e trac.ing an" a"" a ne1 'e!ice#2ehicle recor" on the ='e!ice "min= page. OpenDMT!: Epen'&T6 "e!ices typically use the actual =account= an" ="e!ice= I'*s. In this case ma.e sure the account an" "e!ice i" programme" into the Epen'&T6 compliant "e!ice match the same account an" "e!ice i" create" 1ithin the EpenGTS system. T<1=>: TD102#TD103 "e!ices typically report their uni?ue i"enti)ying in)ormation using the I&3I num,er o) the mo"em. En the =Device Ad"in= page, set the =1ni)ue ID= )iel" to the I&3I !alue in the )ormat S t8_1 !:;<=>?1 !:; T, 1here =1 !:;<=@>?1 !:;= is the I&3I num,er o) the phone HThe =t8_= pre)i7 is use" to help i"enti)y the type o) "e!ice communication ser!er use" to parse the "ata L in this case TD102#TD103I. AspicoreM The spicore client so)t1are reports the uni?ue i"enti)ying in)ormation using the I&3I num,er o) the phone. En the =Device Ad"in= page, set the =1ni)ue ID= )iel" to the I&3I !alue in the )ormat S s<?_1 !:;<=>?1 !:; T, 1here =1 !:;<=@>?1 !:;= is the I&3I num,er o) the phone HThe =s<?_= pre)i7 is use" to help i"enti)y the type o) "e!ice communication ser!er use" to parse the "ata L in this case spicoreI.

OpenGTS Configuration and Installation Manual

Page 30 of 61

@E Creating $our o7n Device Co""unication Server


In or"er )or OpenGTS to recei!e "ata )rom a "e!ice, a customiAe" ='e!ice Communication Ser!er= 1ill nee" to ,e implemente" that un"erstan"s the protocol use" to communicate 1ith the remote "e!ice, an" insert recei!e" e!ents into the S45 "ata,ase. This section pro!i"es a ,rie) "escription o) the e7ample *template* ser!ers pro!i"e" 1ith OpenGTS )or implementing your o1n remote "e!ice communication ser!er. The metho" use" ,y remote "e!ices to transport e!ents to the ser!er !aries greatly 1ith the manu)acturer o) the "e!ice. Some transport "ata to a ser!er !ia S&S messages, some use an S&T6 email transport to sen" "ata to a ser!er, some use an NTT6-,ase" protocol 1hich enco"e "ata in the re?uest to the ser!er, an" many use some )orm o) ra1-soc.et ,ase" communication H!ia TC6#+'6I to connect to a listener on the ser!er to transmit "ata. In or"er to create a "e!ice communication ser!er that is a,le to parse incoming "ata )rom a "e!ice, an intimate un"erstan"ing o) the speci)ics o) the protocol use" ,y the "e!ice manu)acturer is re?uire". OpenGTS inclu"es e7amples )or NTT6-,ase" ser!ers, an" ra1-soc.et ,ase" ser!ers Hsupporting ,oth TC6 an" +'6I, ho1e!er, since each "e!ice manu)acturer typically has their o1n protocol an" 1ay o) transporting "ata, these e7ample ser!ers cannot ,e assume" to Gust-1or. 1ith any#e!ery "e!ice. 'epen"ing on the particular "e!ice chosen, there may ,e a signi)icant an" su,stantial amount o) 1or. necessary in or"er to support the chosen har"1are "e!ice. The )irst, an" most important, step 1hen starting to implement a "e!ice communication ser!er )or a chosen har"1are "e!ice is to o,tain an" )ully un"erstan" the protocol "ocumentation )rom the manu)acturer o) the "e!ice. 0hile http,ase" communication can o)ten ,e re!erse-engineere" )rom o,ser!ing the "ata arri!ing at the ser!er, attempting to re!erse-engineer a ra1-soc.et ,ase" protocol can pro!e e7tremely "i))icult, i) not impossi,le, 1ithout proper protocol "ocumentation. @ aE I"portant note regarding the i"ple"ention of a device co""unication server: Implementing a "e!ice communication ser!er )or a gi!en "e!ice may ta.e a signi)icant an" su,stantial amount o) programming 1or. to accomplish, "epen"ing on the "e!ice protocol. To implement a ser!er, you 1ill li.ely nee" an in-"epth un"erstan"ing o) TC6#+'6 ,ase" communication, an" a goo" un"erstan"ing o) ;a!a programming techni?ues, inclu"ing soc.et communication, multi-threa"ing, an" possi,ly ,it1ise manipulation techni?ues )or e7tracting ,it )iel"s )rom ,inary "ata Hinclu"ing .no1ing 1hether the trac.ing "e!ice sen"s "ata in ,ig-en"ian or little-en"ian )ormatsI. I) using an http-,ase" protocol, you may also nee" an un"erstan"ing o) ho1 ser!lets are ,uilt, an" ho1 they operate 1ithin a Ser!let container, such as pache Tomcat.

OpenGTS Configuration and Installation Manual

Page 31 of 61

@ 1E BTT! ,ased Device Co""unication Servers Dusing the +gpr"c+ servletE 1S"ills re(uired: !ava, Servlets, 0TT/ based protocols2 NTT6-,ase" communication is typically the easiest to implement. I) your remote trac.ing "e!ice sen"s messages to the ser!er using an NTT6-,ase communication protocol, then the e7ample ser!er *gpr c* can ,e mo"i)ie" to parse recei!e" "ata an" insert it into the S45 "ata,ase. The sources )or the *gpr c* ser!er Hname" a)ter the YG6%&C recor" in the J&3 -0183 protocolI can ,e )oun" in the OpenGTS source "irectory =src/org/openg$s/.ar/gpr c= an" runs as a Ser!let in a ser!let container such as pache Tomcat Han" uses the same access ports con)igure" )or TomcatI. @ 1 1E Configuring the +gpr"c+ ServletM This mo"ule has many ,uilt-in con)igura,le options an" may only nee" special customiAation properties 1hich can ,e speci)ie" in the =.e#app.con0= )ile. The )ollo1ing is a list o) con)igura,le properties a!aila,le )or the =gpr c= http,ase" "e!ice communication ser!erM 'ata )ormat#!alue 6roperty DeysM 5ogging output name. 'e)ault !alueM *prA6 *prA6.0n'B0e7re1') +ni?ueI' pre)i7, use" 1hen loo.up up 'e!ice. 'e)aults !alueM %same as $*prA6.&o*N,Ae$ property value& *prA6.2e1,0&tA66o0ntI. 'e)ault account I'. 'e)ault !alueM *prA6 *prA6.A'n'A0ASpee2C7H &inimum accepta,le spee" Hspee"s less than this !alue 1ill ,e set to *0*I 'e)ault !alueM ?.? *prA6.est'A,teO2oAeter I) true, a G6S ,ase" o"ometer 1ill ,e calculate". 'e)ault !alueM 1,&se *prA6.s'A0&,teGeoDones I) true, a geoAone arri!al#"epartures 1ill ,e "etecte", an" the appropriate a""itional e!ents 1ill ,e create". 'e)ault !alueM 1,&se *prA6.2,te3orA,t 'ate )ormat )or *"ate* parameter. 2ali" !aluesM NONE, E7OCH, EM., .ME, M.E 'e)ault !alueM EM. *prA6.response.o8 %esponse returne" to "e!ice on on success)ul "ata receipt. 'e)ault !alueM %nothing returned& *prA6.response.error %esponse on returne" to "e!ice on on unsuccess)ul HerrorI "ata receipt. 'e)ault !alueM %nothing returned&
*prA6.&o*N,Ae

OpenGTS Configuration and Installation Manual

Page 32 of 61

+%5 6arameter 6roperty DeysM


*prA6.p,rA.0n'B0e

+%5 6arameter DeyM +ni?ue-I' 'e)ault !alueM '2 *prA6.p,rA.,66o0nt +%5 6arameter DeyM ccount-I' 'e)ault !alueM ,66t *prA6.p,rA.2e-'6e +%5 6arameter DeyM 'e!ice-I' 'e)ault !alueM de$ *prA6.p,rA.,0t4 +%5 6arameter DeyM uth#6ass1or" Hnot use"I 'e)ault !alueM %blan"& *prA6.p,rA.st,t0s +%5 6arameter DeyM StatusCo"e 'e)ault !alueM 6o2e *prA6.p,rA.*prA6 +%5 6arameter DeyM G6%&C Hthe J&3 -0183 YG6%&C recor" is e7pecte" )or this !alue o) this parameterI 'e)ault !alueM *prA6 *prA6.p,rA.2,te +%5 6arameter DeyM 'ate Hignore" i) **prA6.p,rA.*prA6* is speci)ie"I 'e)ault !alueM 2,te *prA6.p,rA.t'Ae +%5 6arameter DeyM Time Hignore" i) **prA6.p,rA.*prA6* is speci)ie"I 'e)ault !alueM t'Ae *prA6.p,rA.&,t't02e +%5 6arameter DeyM 5atitu"e Hignore" i) **prA6.p,rA.*prA6* is speci)ie"I 'e)ault !alueM &,t *prA6.p,rA.&on*'t02e +%5 6arameter DeyM 5ongitu"e Hignore" i) **prA6.p,rA.*prA6* is speci)ie"I 'e)ault !alueM lon *prA6.p,rA.spee2 +%5 6arameter DeyM Spee"H.phI parameter .ey Hignore" i) **prA6.p,rA.*prA6* is speci)ie"I 'e)ault !alueM spee2 *prA6.p,rA.4e,2'n* +%5 6arameter DeyM Nea"ingH"egreesI Hignore" i) **prA6.p,rA.*prA6* is speci)ie"I 'e)ault !alueM 4e,2 *prA6.p,rA.,&t't02e +%5 6arameter DeyM ltitu"eHmetersI 'e)ault !alueM ,&t *prA6.p,rA.o2oAeter +%5 6arameter DeyM E"ometerH.ilometersI 'e)ault !alueM odo" *prA6.p,rA.,22ress +%5 6arameter DeyM %e!erse-Geoco"e" ""ress 'e)ault !alueM ,22r *prA6.p,rA.2r'-er +%5 6arameter DeyM 'ri!er I' 'e)ault !alueM 2r *prA6.p,rA.Aess,*e +%5 6arameter DeyM &essage 'e)ault !alueM As*

OpenGTS Configuration and Installation Manual

Page 33 of 61

@ 1 #E Default +gpr"c+ ConfigurationM The "e)ault =gpr c= co)iguration H1ith no special con)iguration changes ma"e in the =.e#app.con0= )ileI e7pects a http-,ase" +%5 )ormatte" as )ollo1sM Hthe +%5 ,elo1 "isplays the !arious )iel"s on separate lines, ,ut is normally sent to the ser!er as a single +%5 all on a single lineIM
6$$p=//e5a ple.co =R2R2/gpr c/Oa$aT )(!123FE1XRZ2123FEU co(e!25-222U gpr c!$GAIM7B2R2X21.22BAB312R.XEF2BNB1F2EX.1X1FB@B222.2B222.2B1R2X2XBBBA:17

0here
6$$p=//e5a ple.co =R2R2/gpr c/Oa$aT %epresents the hostMport H=e5a ple.co =R2R2=I an" =gpr c..ar= ser!let location H=#gpr c/Oa$aT=I 123FE1XRZ2123FE %epresents the uni?ue mo,ile I' o) the "e!ice Hsuch as the I&3IVI. HThis !alue shoul" ,e entere" into the ='e!ice "min= page =+ni?ue I'= )iel" in the )ormat =gpr c_123FE1XRZ2123FE=I. 25-222 %epresents the status co"e use" )or i"enti)ying the reason )or the e!ent. The status co"e use" here shoul" match the he7, or "ecimal !alue o) a status co"e liste" in the =Status Co"es an" 'escriptions= manual at the )ollo1ing locationM 6$$p=//....geo$ele a$)c.co /(ocs/S$a$us7o(es.p(0 In a""ition to one o) the a,o!e he7#"ecimal status co"es, any o) the )ollo1ing te7t co"e names may also ,e use", 1hich 1ill automatically ,e con!erte" into it*s correspon"ing he7-,ase" status co"e 1hen it is entere" into the 3!ent'ata ta,leM GAS, AAN87, @AJMAIP, etc, Hsee gprmc source mo"ule =Oa$a.4a"a= )or a current listI. $GAIM7B2R2X21.22BAB312R.XEF2BNB1F2EX.1X1FB@B222.2B222.2B1R2X2XBBBA:17 %epresents the J&3 -0183 YG6%&C recor" straight )rom the G6S recei!er.

@ 1 %E ,uilding the +gpr"c+ ServletM The =gpr c..ar= )ile is automatically ,uilt ,y the EpenGTS =an$+all= comman", ,ut can also ,e ,uilt speci)ically 1ith the )ollo1ing comman"M an$+gpr c )ter ma.ing any con)iguration changes to the a,o!e properties, the =gpr c..ar= )ile must ,e re,uilt an" re"eploye" in or"er )or the con)iguration changes to ta.e e))ect. I) you nee" to ma.e changes to this source mo"ule to support your "e!ice, it is recommen"e" that you copy the source )iles to an ne1 "irectory Hremem,er to change the ;a!a pac.age name, an" also copy#mo"i)y the =.e#.5 l= in)ormation )oun" at =.ar/gpr c/@E;-8N-/.e#.5 l=I, then mo"i)y the copie" sources 1ith the speci)ic changes re?uire" ,y your trac.ing "e!ice. This mo"ule 1ill nee" to ,e con)igure" an" installe" in a ser!let container, similar to the installation process use" )or other ser!lets in this "ocumentation. Consult the *gpr c* ser!er source co"e "irectly )or a""itional in)ormation. HSource co"e )or this mo"ule can ,e )oun" in the "irectory =src/org/openg$s/.ar/gpr c/=I.

OpenGTS Configuration and Installation Manual

Page 34 of 61

@ #E Ra7 Soc6et ,ased Device Co""unication Server 1S"ills re(uired: !ava, T3/456/ soc"et communication, multi7threading, bitwise manipulation, general client4server protocols2 I) your remote trac.ing "e!ice sen"s messages to the ser!er using a soc.et-,ase" communication protocol, then the e7ample *$e pla$e* ser!er can ,e mo"i)ie" to parse recei!e" "ata an" insert it into the S45 "ata,ase. The sources )or the *$e pla$e* ser!er can ,e )oun" in the OpenGTS source "irectory =src/org/openg$s/ser"ers/$e pla$e=. This ser!er type runs as a separate process listening on a selecte" soc.et port )or incoming TC6#+'6 connections. Oou 1ill li.ely nee" to ma.e some signi)icant changes to the source co"e to support your particular "e!ice. It is recommen"e" that you copy the source )iles to an ne1 "irectory Hremem,er to change the ;a!a pac.age nameI, then mo"i)y the copie" sources 1ith the speci)ic changes re?uire" ,y your trac.ing "e!ice. Nere are some o) the main attri,utes o) the protocol that nee" to ,e "etermine" ,e)ore starting to implement a TC6#+'6 soc.et ,ase" "e!ice communication ser!erM re the protocol pac.ets transmitte" in SCII, <inary, or ,othK No1 is the actual length o) a client pac.et "etermine" Hthis is e7tremely importantIK 0hat are the !arious types an" content o) pac.ets recei!e" )rom the clientK (or ,inary pac.ets, are integer )iel"s enco"e" in <ig-3n"ian or 5ittle-3n"ian )ormatK 0hat response pac.ets, i) any, is the client e7pecting to recei!e )rom the ser!erK The e7ample *template* ser!er contains the )ollo1ing source mo"ulesM 7ons$an$s.4a"a L This mo"ule constains most o) the customiAe" con)igura,le options use" to support your speci)ic remote "e!ice protocol. Such as timeouts, minimum#ma7imum pac.et lengths, SCII#<inary enco"ing, etc. The ,asic in)ormation regar"ing the type o) protocol shoul" ,e set in this mo"ule. Ma)n.4a"a L This is the main entry point )or the ser!er an" 1ill not li.ely nee" to ,e mo"i)ie". Trac/7l)en$Aac/e$Han(ler.4a"a L The purpose o) this mo"ule is to un"erstan"s the speci)ic characteristics o) the communication protocol )or the remote "e!ice, an" 1ill re?uire most o) the signi)icant customiAation re?uire" to support your remote "e!ice. This is 1here incoming client pac.ets are i"enti)ie", "ata is parse" an" inserte" into the ta,les, an" any re?uire" responses are returne" to the client "e!ice. Trac/Ser"er.4a"a L This is a 1rapper#han"ler )or a TC6#+'6 session an" "elegates most control to the Trac/7l)en$Aac/e$Han(ler class. This ser!er en!ironment#)rame1or. han"les listening )or incoming connections an" multi-threa"ing )or you Hthis ser!er can han"le multiple simultaneous incoming connectionsI, as 1ell as most error han"ling. 0hen using the e7ample *$e pla$e* ser!er as the ,asis )or your o1n "e!ice communication ser!er, it is recommen"e" that you copy the *$e pla$e* )iles into a ne1 )ol"er Han" thus a ne1 ;a!a pac.ageI name" a)ter your chosen trac.ing#telematic "e!ice Hie. such as =ac e1222=I. The =#u)l(.5 l= )ile shoul" also ,e mo"i)ie" to inclu"e a *target* )or your chosen ser!er name. To ,uil" the e7ample *$e pla$e* ser!er, the nt target *$e pla$e* can ,e use" as )ollo1sM M+an$+$e pla$e This *$e pla$e* target in *#u)l(.5 l* can ,e copie" to create your o1n speci)ic ant ,uil" target )or your chosen "e!ice communication ser!er name. Consult the *$e pla$e* ser!er source co"e "irectly )or a""itional customiAation in)ormation. The ser!er =)care= is also a!aila,le Hin the source "irectory =src/org/openg$s/ser"ers/)care/=I, 1hich supports the ICare G3300 "e!ice. This "e!ice communication ser!er mo"ule can also ,e e7amine" )or help in creating your o1n customiAe" "e!ice communication ser!er.

OpenGTS Configuration and Installation Manual

Page 35 of 61

@ # 1E Starting the Device Co""unication Server Ence your ser!er Gar )ile has ,een create", you can use the =#)n/runser"er.s6= comman" Hor =runser"er.#a$= on 0in"o1sI to start your "e!ice communication ser!er as )ollo1sM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+#)n/runser"er.s6+-s+$e pla$e

@ # 1 aE I"portant note regarding + sh+ and + /at+ co""and files: Comman"s en"ing 1ith =.sh= or =.,at= &+ST ,e e7ecute" )rom the OpenGTS installation "irectory. ttempting to e7ecute these comman"s )rom another "irectory may result in a =ClassJot(oun"37ception= or =JoClass'e)(oun"3rror= error, or similar. HThis means that you must c" to JGTSHBOM&, then e7ecute the comman" as =#)n/%comman+M=I Er, the 6erl !ersion o) this comman" can ,e use" 1ithout nee"ing to ,e in the OpenGTS installation "irectoryM
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+$e pla$e

En 0in"o1s, the comman" can omit the =-s= an" can ,e entere" as )ollo1sM
C-.>+c(+HOpenGTS_1.2.3 C-.!pen"TS#$%&%'.>+H#)nHrunser"er.#a$+$e pla$e

The ser!er 1ill initialiAe an" start listening on the portHsI speci)ie" in the =(cser"ers.5 l= )ile )or the =$e pla$e= ser!er. The "e)ault port is 31222. To change the listen port on the comman" line, a =-por$= can ,e a""e" as )ollo1sM
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+$e pla$e+-por$+31123

Er, on 0in"o1sM
C-.!pen"TS#$%&%'.>+H#)nHrunser"er.#a$+$e pla$e+-por$=31123

To set listening on port =31123= H)or e7ampleI. Oou can also a"" the comman"-line option =-(e#ugMo(e= to ena,le "e,ug-le!el logging. 0hile running in =,ac.groun"= mo"e, the output logs are store" in the )ile =$GTS_HOME/logs/$e pla$e.log=. HThe )ile =$e pla$e.ou$= is also create" in this "irectory to catch any st"out#st"err messages 1hich are "isplaye" 1ithin the ser!er that "on*t use the *6rint* logging )eature ,uilt into EpenGTS. Typically, this )ile shoul" al1ay ,e emptyI. 0hen testing#"e,ugging, you may also start a ser!er =interacti!ely=. That is, the ser!er is run in the )oregroun" Hie. not *,ac.groun"e"*I, an" all logging output is sent to the console instea" o) the log )ile. To start a ser!er =interacti!ely=, a"" the option =-i= to the comman" line, as )ollo1sM
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+$e pla$e+-)

HTo stop the ser!er in this mo"e, simply press *Control-C*I

OpenGTS Configuration and Installation Manual

Page 36 of 61

@ # #E Stopping the Device Co""unication Server 0hen starte" in =,ac.groun"= mo"e Hie. 0ithout the =-)= optionI, a =6rocess I'= H6I'I )ile is create" at =$GTS_HOME/logs/$e pla$e.p)(=, 1hich contains the process-i" o) the ,ac.groun"e" tas.. This )ile is use" to stop the ser!er 1ith the comman"M
/zzz>+$GTS_HOME/#)n/runser"er.pl+-s+$e pla$e+-/)ll

En 5inu7 systems, the 6erl comman" =ps4a"a=, inclu"e" 1ith OpenGTS, can ,e use" to "isplay in)ormation regar"ing 1hich 'e!ice Communication Ser!ers are currently running, inclu"ing the =$e pla$e= ser!erM
/zzz>+$GTS_HOME/#)n/ps4a"a ++A8O++Aaren$++,+Lser+++++Ja"a+class/4ar ------+------++-+--------+------------------------------------------------------+++21EV+++++1W+1+openg$s++org.apac6e.ca$al)na.s$ar$up.;oo$s$rap++ ++R11EV+++++1W+1+openg$s++/usr/local/OpenGTS_1.2.3/#u)l(/l)#/g$s( $p.4ar++ ++R12ZV+++++1W+1+openg$s++/usr/local/OpenGTS_1.2.3/#u)l(/l)#/$e pla$e.4ar++

This comman" lists all .no1n running ;a!a processes, 1ith their associate" 6I' Hprocess-i"I, parent 6I', user, an" ;a!a class or Gar )ile 1hich is currently running. The =org.apac6e.ca$al)na.s$ar$up.;oo$s$rap= process in"icates that pache Tomcat is running 1ith the in"icate" 6I'. =g$s( $p= an" =$e pla$e= in"icate their respecti!e running 'e!ice Communication Ser!ers. @ %E Runti"e FM( Configuration 4ile The ra1 soc.et-,ase" "e!ice communication ser!ers Hsuch as the e7ample *template* ser!erI support the runtime con)iguration using the )ile =(cser"ers.5 l=. n e7ample )ormat o) the =(cser"ers.5 l= is as )ollo1sM %O7Ser"er7on0)g ++++#)n(A((ress!<< ++++#ac/log!<< ++++por$O00se$!<2< ++++)nclu(eO)r!<(cser"ers< ++++M ++++%8nclu(e+0)le!<(cser"er_$e pla$e.5 l<+op$)onal!<$rue</M ++++%O7Ser"er+na e!<)care<M +++++++... ++++%/O7Ser"erM ++++... %/O7Ser"er7on0)gM The attri,utes )or the O7Ser"er7on0)g tag inclu"e the )ollo1ingM #)n(A((ress M This attri,ute speci)ies the local I6 a""ress or host name to 1hich the ser!er 1ill ,in". This is use)ul 1hen the local ser!er has more than one I6 a""ress, an" nee"s to sen" +'6 pac.ets ,ac. to a client "e!ice. I) le)t ,lan., the ser!er 1ill ,in" to the "e)ault local I6 a""ress. #ac/log M The ma7imum ?ueue length )or incoming connection in"ications Ha re?uest to connectI. I) a connection in"ication arri!es 1hen the ?ueue is )ull, the connection is re)use". I) le)t ,lan., or is 0 or less, then the "e)ault ,ac.log !alue 1ill ,e use". See the class =4a"a.ne$.Ser"erSoc/e$= )or more in)ormation. por$O00se$ M This !alue is a""e" to any port speci)ication. +nless other1ise nee"e" )or speci)ic system re?uirements, this !alue shoul" remain =0=. )nclu(eO)r M I) the =O7Ser"er7on0)g= tag contains any =8nclu(e= su,-tags, this is the "irectory that 1ill ,e search )or the inclu"e" )iles.
OpenGTS Configuration and Installation Manual

Page 37 of 61

n e7ample =8nclu(e= tag )ormat is as )ollo1sM %8nclu(e+0)le!<(cser"er_$e pla$e.5 l<+op$)onal!<$rue</M The attri,utes )or the 8nclu(e tag inclu"e the )ollo1ingM 0)le M This attri,ute speci)ies the name o) the )ile to inclu"e. The inclu"e" )ile must also ,e a properly )ormatte" 'CSer!erCon)ig 9&5 )ile. ll "e!ice communication ser!ers "e)ine" 1ithin this inclu"e" )ile Has "e)ine" ,y the ='CSer!er= tagsI 1ill ,e a""e" to the "e!ice communication ser!ers "e)ine" els1here in this 9&5 )ile. %ecursi!e Inclu"e "irecti!es are not allo1e". op$)onal M This attri,ute speci)ies 1hether the inclu"e )ile is re?uire" to e7ist. I) this !alue is =$rue= an" the inclu"e )ile "oes not e7ist, an" error 1ill ,e "isplaye". I) this !alue is =0alse= an" the inclu"e )ile "oes not e7ist, then the 8nclu(e "irectory is ?uietly ignore". n e7ample =O7Ser"er= tag )ormat is as )ollo1sM %O7Ser"er+na e!<$e pla$e<M +++%Oescr)p$)onM%['7OATA' +++++++E5a ple+Te pla$e+Ser"er +++++++**M%/Oescr)p$)onM +++%Ln)Due8OAre0)5M%['7OATA' +++++++$e pla$e_ +++++++) e)_ +++++++: +++++++**M%/Ln)Due8OAre0)5M +++%,)s$enAor$s+ +++++++$cpAor$!<31222<+ +++++++u(pAor$!<31222< +++++++/M +++%Aroper$)esM +++++++%Aroper$&+/e&!< )n) u Spee(PAH<MF.2%/Aroper$&M +++++++%Aroper$&+/e&!<es$) a$eO(o e$er<M$rue%/Aroper$&M +++++++%Aroper$&+/e&!<s) ula$eGeoGones<M$rue%/Aroper$&M +++++++%/Aroper$)esM %/O7Ser"erM The attri,ute )or the O7Ser"er tag are as )ollo1sM na e M This attri,ute is re?uire" an" speci)ies the name o) the "e!ice communication ser!er. The speci)ie" name shoul" ,e uni?ue among all loa"e" "e!ice communication ser!ers. I) a name o) a "e!ice communication ser!er is encountere" that has alrea"y ,een "e)ine", the su,se?uent name" 'CSer!er entry 1ill ,e ignore". =Oescr)p$)on= su,-tagM This tag speci)ies the optional "escription o) the "e!ice communication ser!er. =Ln)Due8OAre0)5= su,-tagM This tag speci)ies the optional =+ni?ue-I'= pre)i7es that 1ill ,e use" 1hen loo.ing up the "e!ice mo,ile-i" in the 'e!ice ta,le. In the or"er speci)ie", the speci)ie" pre)i7 is prepen"e" to the mo,ile-i" then the resulting I' is loo.e"-up in the 'e!ice ta,le =un)Due8O= )iel". I) not )oun", then the ne7t pre)i7 1ill ,e use". The pre)i7 speci)ication =:= means that the mo,ile-i" 1ill ,e use" as-is H1ithout any prepen"e" pre)i7I.

OpenGTS Configuration and Installation Manual

Page 38 of 61

=,)s$enAor$s= su,-tagM This tag speci)ies the ports on 1hich the "e!ice communication ser!er 1ill listen )or incoming connections )rom remote "e!ices. The attri,ute =$cpAor$= speci)ies the port on 1hich a TC6 listener 1ill ,e starte". The attri,ute =u(pAor$= speci)ie" the port on 1hich a +'6 listener 1ill ,e starte". I) either =$cpAor$= or =u(pAor$= is ,lan., or not speci)ie", the the correspon"ing =listener= 1ill not ,e starte". =Aroper$)es= su,-tagM This tag inclu"es =Aroper$&= su,-tags 1hich speci)y runtime properties 1hich can ,e use" to )urther speci)y the ,eha!ior o) the "e!ice communication ser!er at runtime. The stan"ar" properties that most "e!ice communication ser!er recogniAe are as )ollo1sM )n) u Spee(PAH M H'ou,leI This property speci)ies the minimum accepta,le G6S-,ase" spee". spee" !alue ,eo1 the !alue speci)ie" ,y this property 1ill ,e consi"ere" a spee" o) *0*. This is use" to mitigate G6S spee" !alues 1hich can in"icate motion, e!en 1hen the G6S recei!er is stationary. es$) a$eO(o e$er M H<ooleanI This property speci)ies the 1hether a G6S-,ase" o"ometer !alue shoul" ,e automatically calculate" )rom the !ali" G6S locations reporte" ,y the incoming e!ent. The o"ometer !alue o) the current e!ent is calculate" ,y "etermining the "istance )rom the pre!ious e!ent location to the current e!ent location, then a""ing this "istance to the pre!ious o"ometer !alue. s) ula$eGeoGones M H<ooleanI This property speci)ies 1hether incoming e!ents shoul" ,e chec.e" )or GeoAone arri!e#"epart occurances. I) the current e!ent 1as )oun" to ha!e arri!e, or ha!e "eparte", )rom a GeoAone Has liste" in the GeoAone ta,leI, then the appropriate e!ent, 1ith the arri!e#"epart status co"e, 1ill ,e generate" an" inserte" into the 3!ent'ata ta,le. Speci)ic "e!ice communication ser!ers may also support other property speci)ications.

OpenGTS Configuration and Installation Manual

Page 39 of 61

1=E Internationali2ation/(ocali2ation
The OpenGTS source co"e is i18n H=internationaliAation=I compliant, 1hich means that it can a"apte" to !arious lanugages 1ithout re?uiring any co"e changes Hie. no )i7e" har"co"e" te7t that cannot ,e change" at "isplay timeI. 5ocaliAation H=510n=I is the process o) applying language speci)ic te7t )or a gi!en 5ocale. 1= 1E Supporting a ?e7 (anguage ll 3nglish te7t 1hich is "isplaya,le 1ithin the OpenGTS 1e,-inter)ace can ,e )oun" in the resource property )iles calle" =,ocalS$r)ngs_en.proper$)es= )oun" 1ithin the !arious source )ile "irectories. These )iles contain a listing o) the "e)ault 3nglish te7t 1hich 1ill ,e "isplaye" i) no speci)ic locale has ,een chosen. The )ormat o) this )ile is =te5$Pe&!"alue=, 1here the =$e5$Pe&= is a uni?ue i" )or the speci)ic te7t ="alue=. 1= 1 aE Do7nload the latest (ocale files for the ne>t release: Oou can "o1nloa" a Aip )ile containing the =,ocalS$r)ngs_55.proper$)es= )iles )or the ne7t release o) EpenGTS at the )ollo1ing +%5M +++++++6$$p=//....geo$ele a$)c.co /(o.nloa(.6$ l3,ocalS$r)ngs To support a ne1 language#locale, search )or e!ery occurance o) the )ile =,ocalS$r)ngs_en.proper$)es= an" create a copy name" =,ocalS$r)ngs_XX.proper$)es= in the same "irectory, 1here =XX= in this case is the ISOC0%@ 2-letter language co"e. Then in the ne1 )ile, remo!e the pre)i7ing =3= comment character on each .eyW!alue line, an" mo"i)y the te7t !alue to match your speci)ic language synta7 an" meaning. &a.e sure to lea!e the te7t .ey as-is. The contents o) the =,ocalS$r)ngs_XX.proper$)es= )iles "ust ,e 1ritten using only ISOC::-@C1 enco"e" characters Hper =4a"a.u$)l.Aroper$)es= an" =4a"a.u$)l.Iesource;un(le= restrictionsI. Characters that cannot ,e "irectly represente" in ISOC::-@C1 can ,e inclu"e" using 1nicode escapes ,y speci)ying the )ormat *HuXXXX*, 1here *XXXX* is the he7 representation o) the unico"e character. The ;a!a ;'D installation inclu"es the tool *na$)"e2asc))* to assist 1ith con!erting unico"e te7t to unico"e escape" te7t. I) a =,ocalS$r)ngs_\\.proper$)es= )ile "oes not contain proper 1nicode enco"ing Hie. an in!ali" =HuXXXX= speci)icationI, then ;a!a may ,e una,le to loa" the properties )ile, an" the speci)ic 5ocalStrings )ile may not ,e use". To !eri)y that no in!ali" =HuXXXX= speci)ications are present, the )ollo1ing Chec.Install comman" 1ill !ali"ate the =,ocalS$r)ngs_XX.proper$)es= )ilesM
/zzz>+$GTS_HOME/#)n/c6ec/8ns$all.s6+--+-localS$r)ngs!$GTS_HOME/src

This comman" 1ill search )or all =,ocalS$r)ngs_XX.proper$)es= )iles in the =$GTS_HOME/src= "irectory an" e7amine their contents )or in!ali" =HuXXXX= speci)ications. I) any 5ocalStrings )ile contains in!ali" =HuXXXX= speci)ications, the error message =&al)orme" Fu7777 enco"ing= 1ill ,e "isplaye" )or the particular )ile. This comman" 1ill also chec. to see that only ISOC::-@C1 characters are use" in the 5ocalStrings )iles. The speci)ic language locale "isplaye" on the 1e,-inter)ace is controlle" ,y the =locale= attri,ute on the =Oo a)n= tag in the =pr)"a$e.5 l= )ile. )ter ma.ing any changes to the =pr)"a$e.5 l= )ile, or any o) the =,ocalS$r)ngs_\\.proper$)es= )iles, ma.e sure you re,uil" an" re"eploy the =$rac/..ar= )ile. 1= #E Changing the Displa$ed (anguage Setting the "isplaye" language can ,e con)igure" in the *pr)"a$e.5 l* )ile. En the =Oo a)n= tag, change the =locale= to the "esire" 2-letter country co"e. (or e7ample, to change the language to German, set the 'omain =locale= attri,ute to *locale!<(e<*. Oou can also a"" a pull-"o1n language selection menu to the login page ,y setting the 6roperty =accoun$,og)n.s6o.,ocaleSelec$)on= to =$rue=. The language selections are speci)ie" in the =Suppor$e(,ocales= tag. H%e,uil"#re"eploy the *$rac/..ar* )ile a)ter ma.ing any changes to the *pr)"a$e.5 l* )ile.I

OpenGTS Configuration and Installation Manual

Page 40 of 61

11E Creating/Modif$ing Reports


OpenGTS comes 1ith a !ery simple an" con)igura,le report generation engine. %eports are comprise" o) 3 main componentsM the report layout, the report "ata iterator, an" the report speci)ication 9&5. The report speci)ication 9&5 speci)ies a report "ata iterator, reporting constraints, an" the columns 1hich are to appear on the report. The report "ata iterator constructs the "ata 1hich 1ill ,e inclu"e" in the report ,ase" on the reporting constraints. The report "ata layout then iterates through the report "ata an" generates a report ,ase" on the column )ormatting in)ormation pro!i"e" ,y the report speci)ication 9&5. The =%eport 5ayout= an" =%eport 'ata Iterator= components must ,e implemente" in ;a!a co"e ,y a ;a!a programmer, an" shoul" ,e con)igura,le )or a general use. The =%eport Speci)ication 9&5= is a report con)iguration te7t )ile that speci)ies the type, columns, an" contraints )or a speci)ic report. 6ro!i"e" the report layout an" "ata iterator are implemente" )or general use, many "i))erent .in"s o) reports may ,e create" that utiliAe the same layout an" "ata iterator. 11 1E Report (a$out The %eport 5ayout is a ;a!a mo"ule that "e)ines 1hat columns are a!aila,le )or a gi!en report, an" their respecti!e )ormatting options. report layout must e7ten" the a,stract ;a!a class =org.openg$s..ar.repor$.Iepor$,a&ou$= an" must "e)ine a =Oa$aIo.= su,class that un"erstan"s ho1 to parse report columna#)iel"s )rom report ro1 o,Gects pro!i"e" ,y the report "ata iterator. The class =org.openg$s..ar.repor$.e"en$.E"en$Oa$a,a&ou$= is an e7ample %eport5ayout su,class that "e)ines the a!aila,le columns an" )ormatting options )or the 3!ent 'etail an" Summary reports. 11 #E Report Data Iterator The %eport 'ata Iterator is a ;a!a mo"ule that constructs the list o) recor"s that are to ,e inclu"e" in the report ,ase" on the constraints speci)ie" in the report speci)ication 9&5. report "ata iterator must e7ten" the a,stract ;a!a class =org.openg$s..ar.repor$.Iepor$Oa$a= an" pro!i"e implementations )or the =ge$;o(&Oa$a8$era$or= an" =ge$To$alOa$a8$era$or= metho"s. It must also ,in" to a speci)ic %eport5ayout ,y pro!i"ing an implementation )or the =ge$Iepor$,a&ou$= metho". The class =org.openg$s..ar.repor$.e"en$.E"en$Oe$a)lIepor$= is an e7ample %eport'ata su,class that generates the 3!ent 'etail report.

OpenGTS Configuration and Installation Manual

Page 41 of 61

11 %E Report Definition FM( The )ile =repor$.5 l= "e)ines the html style use" )or a column "e)ine" in a %eport5ayout. I) also "e)ines speci)ic reports ,y speci)ying 1hich %eport'ata iterator, an" 1hich columns 1ill ,e inclu"e" in a gi!en report. It also speci)ies the constraints that are to ,e applie" to the "ata 1hich the report 1ill contain. Nere is an e7ample report "e)inition )rom the *repor$.5 l* )ile )or the =3!ent 'etail= reportM
%[--+ +!!!+T6e+Qna eQ+pro")(es+a+na e+0or+$6e+repor$B+re0erence(+)n+Qpr)"a$e.5 lQ +!!!+T6e+Q$&peQ+pro")(es+a+repor$+group+na eB+re0erence(+)n+Qpr)"a$e.5 lQ +!!!+T6e+QclassQ+spec)0)es+$6e+repor$+(a$a+)$era$or+use(+$o+genera$e+$6e+repor$ +--M %Iepor$+na e!<E"en$Oe$a)l<+$&pe!<(e")ce.(e$a)l< ++++class!<org.openg$s..ar.repor$.e"en$.E"en$Oe$a)lIepor$<M +++%[--+T6e+(escr)p$)on+o0+$6e+repor$+()spla&+on+$6e+repor$)ng+ enu+--M +++%MenuOescr)p$)on+)1Rn!<Iepor$s\M,.e"en$Oe$a)l. enu<M ++++++E"en$+Oe$a)l +++%/MenuOescr)p$)onM +++%[--+T6e+$)$le+()spla&e(+a#o"e+$6e+repor$+--M +++%T)$le+)1Rn!<Iepor$s\M,.e"en$Oe$a)l.$)$le<M ++++++E"en$+Oe$a)l +++%/T)$leM +++%[--+T6e+su#$)$le+()spla&e(+a#o"e+$6e+repor$+--M +++%Su#$)$le+)1Rn!<Iepor$s\M,.e"en$Oe$a)l.su#$)$le<M ++++++$>(e")ceOesc?+'$>(e")ce8(?*Hn$>(a$eIange? +++%/Su#$)$leM +++%[--+T6e+colu +++%7olu nsM ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na ++++++%7olu n+na +++%/7olu nsM ns+)nclu(e(+)n+$6e+repor$+--M e!<)n(e5<+++++++++++++++++++++++/M e!<(a$e<++++++++++++++++++++++++/M e!<$) e<++++++++++++++++++++++++/M e!<s$a$usOesc<++++++++++++++++++/M e!<la$)$u(e<++++++++++++arg!<E<+/M e!<long)$u(e<+++++++++++arg!<E<+/M e!<spee(H<++++++++++++++arg!<1<+/M e!<al$)$u(e<++++++++++++++++++++/M e!<o(o e$er<++++++++++++arg!<2<+/M e!<a((ress<+++++++++++++++++++++/M

+++%[--+T6e+repor$+(a$a+cons$ra)n$s+--M +++%7ons$ra)n$sM ++++++%Selec$)on,) )$+$&pe!<0)rs$<M1222%/Selec$)on,) )$M ++++++%Iepor$,) )$M1222%/Iepor$,) )$M ++++++%Or(erAscen()ngM$rue%/Or(erAscen()ngM +++%/7ons$ra)n$sM +++%[--+$6e+ ap+)con+selec$or+V)0+ ap+()spla&+)s+ena#le(W+--M +++%Map8conSelec$or+rule-ac$or&Na e!<7us$o IulesEng)ne<M ++++++%[--+$6)s+sec$)on+reDu)res+an+)ns$alle(+<Iule-ac$or&<+) ple en$a$)on+--M ++++++%['7OATA'+VV p6%FWT<re((o$<=Vspee(%1EWT<&ello.<=<6ea()ng<W+**M +++%/Map8conSelec$orM+ %/Iepor$M

OpenGTS Configuration and Installation Manual

Page 42 of 61

11 'E Availa/le Report Specifications Ence a report has ,een "e)ine" in the =repor$.5 l= )ile, it can ,e ma"e a!aila,le )or user selection in the 1e,inter)ace ,y re)erencing the report name in the =pr)"a$e.5 l= )ile in the =Iepor$s= tag. Nere is an e7ample report speci)ication )rom the =pr)"a$e.5 l= )ileM ++%[--+Oe0)ne(+repor$s +++!!!+All+repor$s+re0erence(+6ere+ us$+#e+pre(e0)ne(+)n+Qrepor$s.5 lQ+ +++--M ++%Iepor$sM +++++%Iepor$+na e!<E"en$Oe$a)l<M ++++++++%AclNa eMacl.repor$.e"en$Oe$a)l%/AclNa eM ++++++++%/Iepor$M +++++%Iepor$+na e!<E"en$Su ar&<M ++++++++%AclNa eMacl.repor$.e"en$Su ar&%/AclNa eM ++++++++%/Iepor$M +++++%[--+...+--M ++%/Iepor$sM

OpenGTS Configuration and Installation Manual

Page 43 of 61

Appendi>E AE Support for Microsoft S.( Server


Initial support )or &icroso)t S45 Ser!er has ,een inclu"e" 1ith the stan"ar" OpenGTS. &icroso)t S45 Ser!er 200$ can ,e "o1nloa"e"#installe" )rom the )ollo1ing &icroso)t 1e,pageHsIM 6$$p=//.... )croso0$.co /sDlser"er/222E/en/us/e5press.asp5 6$$p=//.... )croso0$.co /SDlser"er/222E/en/us/e5press-(o.n.asp5 To ena,le support )or S45 Ser!er, mo"i)y the )ile =co support )or &icroso)t S45 Ser!erM on.con0= accor"ingly to turn o)) support )or &yS45, an" turn on

3+---+M)croso0$+SK,+Ser"er (#.sDl.pro")(er!sDlser"er (#.sDl.6os$!local6os$ (#.sDl.por$!31Z3 (#.sDl.(#na e!g$s (#.sDl.user!g$s (#.sDl.pass.or(!openg$s (#.sDl.url!4(#c=sDlser"er=//$>(#.sDl.6os$?=$>(#.sDl.por$? (#.sDl.url.(#!$>(#.sDl.url?C(a$a#aseNa e!$>(#.sDl.(#na e? The ;'<C "ri!er support )or S45 Ser!er 1ill also nee" to ,e "o1nloa"e"#installe" into the ;a!a runtime en!ironments "escri,e" ,elo1. 'o1nloa"M 6$$p=// s(n. )croso0$.co /en-us/(a$a/001EREFZ InstallM "JAVA_HOME"H4reHl)#He5$H. %where %JAVA_HOME% is the location o your !ava installation& Ence =co on.con0= ha!e ,een mo"i)ie", an" the S45 Ser!er ;'<C "ri!er has ,een installe", recompile the OpenGTS co"e an" initialiAe the "ata,ase, an" install the components, as "escri,e" a,o!e in this "ocument. 6lease contact us 1ith any issues you encounter, or suggestions you may ha!e regar"ing support )or &icroso)t S45 Ser!er.

OpenGTS Configuration and Installation Manual

Page 44 of 61

Appendi>E ,E Support for Mologogo Capa/le !hones


OpenGTS inclu"es the ser!let * ologogo..ar* H7e,-archi!eI to recei!e "ata )rom &ologogo capa,le phones HhttpM##111.mologogo.comI using their =alt+%5= )eature. * ologogo..ar* runs in a ;a!a Ser!let container an" stores recei!e" "ata in the S45 '< 1hich can ,e !ie1e" through the 1e, inter)ace Hsee *$rac/..ar*I. Configuring the +7e/app conf+ file: The "e)ault runtime con)iguration )ile =.e#app.con0= )ile, an" =co on.con0= )ile, are )oun" in the EpenGTS installation "irectory. (or most installations, the "e)ault !alues speci)ie" in this )ile can ,e le)t as-is. Shoul" you 1ish to customiAe this )ile speci)ic )or the = ologogo..ar= ser!let, then copy this )ile to the "irectory =$GTS_HOME/.ar/ ologogo/@E;-8N-/= an" mo"i)y this copy. , 1E Co"piling/Installing the +"ologogo 7ar+ *ava Servlet: To ,uil" the = ologogo..ar= )ile, run the nt ,uil" comman" as )ollo1sM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+an$+ ologogo

The target = ologogo= is a 1rapper )or ant targets = ologogo.co p)le= an" = ologogo..ar=. The target = ologogo.co p)le= compiles all necessary classes an" con)iguration )iles into the ,uil" "irectory =$GTS_HOME/#u)l(/ ologogo=. The target = ologogo..ar= then creates the *1e, archi!e* )ile =$GTS_HOME/#u)l(/ ologogo..ar=. Install the = ologogo..ar= )ile per the pache Tomcat installation#con)iguration instructions. Typically, this means copying the = ologogo..ar= )ile to the "irectory =$7ATA,8NA_HOME/.e#apps/.=. , #E Creating the +"ologogo+ account in OpenGTS: +se the comman" line a"min tools to create an account calle" =mologogo= as )ollo1sM
/zzz>+c(+$GTS_HOME /usr/local/!pen"TS#$%&%'>+#)n/a( )n.s6+Accoun$+-accoun$! ologogo+-crea$e

Then, )or each phone, create a ne1 "e!iceM


/usr/local/!pen"TS#$%&%'> #)n/a( )n.s6+Oe")ce+-accoun$! ologogo+-(e")ce! o +-crea$e /usr/local/!pen"TS#$%&%'> #)n/a( )n.s6+Oe")ce+-accoun$! ologogo+-(e")ce!(a(+-crea$e

Hetc.I

, #aE I"portant note regarding + sh+ and + /at+ co""and files: Comman"s en"ing 1ith =.s6= or =.#a$= &+ST ,e e7ecute" )rom the OpenGTS installation "irectory. ttempting to e7ecute these comman"s )rom another "irectory may result in a =ClassJot(oun"37ception= or =JoClass'e)(oun"3rror= error, or similar. HThis means that you must c" to JGTSHBOM&, then e7ecute the comman" as =#)n/%comman+M=I , #/E I"portant note for Iindo7s users: 0hen using the =.#a$= !ersion o) the comman"s in a 'ES 1in"o1, comman" arguments such as -,66o0nt=sA't4 must either ,e enclose" in ?uotes, as in "-,66o0nt=sA't4", or ,e speci)ie" 1ith a colon instea" o) an e?ual sign, as in -,66o0nt:sA't4 .

OpenGTS Configuration and Installation Manual

Page 45 of 61

, %E Setting the +alt1R(+ feature on $our Mologogo phone: Set the =alt+%5= )eature o) your &ologogo capa,le phone to the )ollo1ing +%5M =6$$p=//(my+omainname>/ ologogo/Oa$aT8O!(i+>U= %eplace (my+omainname> 1ith the "omain name o) your ser!er running Tomcat, an" replace (i+> 1ith the I' o) the speci)ic phone Hsuch as = o = or =(a(= in this caseI. Jote that i) you le)t Tomcat running on the "e)ault port 8080, then your +%5 may nee" to ,e set to the )ollo1ingM =6$$p=//% &(o a)nna eM=R2R2/ ologogo/Oa$aT8O!%)(MU= , 'E Testing the installation: Ence e!erything is set up, loo. )or "ata coming in )rom your &ologogo ena,le" phone. JoteM +sing the =8O!= .ey1or" attempts to loo. up the i"entity o) the "e!ice ,y using the "e)ault account i" ="ologogo=. I) you 1ish to use a speci)ic account an" "e!ice i", you can replace the =T8O!(i+>= 1ith =Tacc$!(acct>U(e"!(+ev>=.

OpenGTS Configuration and Installation Manual

Page 46 of 61

Appendi>E CE Optional Ta/le Colu"ns 2arious ta,les 1ithin the EpenGTS pro!i"e )or a""itional ta,le columns 1hich can ,e use" )or special application re?uirements. These ta,le columns can ,e ena,le" ,y setting speci)ic propery !alues 1ithin one o) the a!aila,le =.con0= )iles Hie. =con0)g.con0=, etcI. The )ollo1ing section "escri,es the !arious optional ta,le columns, an" the property name that can ,e use" to ena,le these columns. )ter a""ing the speci)ie" property to the chosen =.con0= )ile, the ta,les 1ill nee" to ,e up"ate" 1ith the ne1ly a""e" columns. To up"ate the ta,le columns, run the =(#A( )n.pl= comman" as )ollo1sM
/usr/local/!pen"TS#$%&%'>+#)n/(#A( )n.pl+-$a#les!ca

Er, on 0in"o1sM
C-.!pen"TS#$%&%'>+#)nH(#7on0)g.#a$+-$a#les=ca

C aE IM!ORTA?T: Redeplo$ all servlets after "odif$ing an$ runti"e configuration file Changes to any o) =pr)"a$e.5 l=, =repor$s.5 l=, =.e#app.con0=, =co on.con0=, =s&s$e .con0=, or =cus$o .con0= )iles Hor other =.5 l= or =.con0= )ileI 1ill re?uire that the =$rac/..ar= Has 1ell as the other ser!letsI )ile ,e re-,uilt an" re-"eploye".

JoteM The )iel"s "escri,e" ,elo1 may only contain a partial listing o) the )iel"s 1hich may ,e a!aila,le in the !arious ta,le optional )iel"s. 6lease consult the ta,le source mo"ule )or a "e)initi!e list o) inclu"e" )iel"s. C 1E Optional Account Ta/le Colu"ns: Address4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Accoun$.A((ress-)el(8n0o!$rue These )iel"s are use" to store a""itional ""ress in)ormation, as speci)ie" ,y application re?uirements. a((ress,)ne1 a((ress,)ne2 a((ress,)ne3 a((ress7)$& a((ressS$a$e a((ressAos$al7o(e a((ress7oun$r& Map(egend4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Accoun$.Map,egen(-)el(8n0o!$rue These )iel"s are use" to store custom map legen" in)ormation. ap,egen(Oe")ce ap,egen(Group AccountManagerInfo 3on ig /ropertyM s$ar$up8n)$.Accoun$.Accoun$Manager8n0o!$rue These )iel"s are use" to store ccount &anager con)iguration in)ormation. )sAccoun$Manager anager8O

OpenGTS Configuration and Installation Manual

Page 47 of 61

Data!ushInfo 3on ig /ropertyM s$ar$up8n)$.Accoun$.Oa$aAus68n0o!$rue These )iel"s are use" to store the state o) certain account#e!ent "ata *pushe"* to an alternate ser!erM reDues$Aass7o(e reDues$8AA((ress (a$aAus6LI, las$Oa$aIeDues$T) e las$Oa$aAus6T) e C #E Optional Device Ta/le Colu"ns: ?otification4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.No$)0)ca$)on-)el(8n0o!$rue These )iel"s are use" ,y the installe" =Iule-ac$or&= implementation, or possi,ly the e7ten"e" 3!ent Joti)ication %ules 3ngine H3J%3I mo"ule. En the open-source EpenGTS !ersion, this can ,e the Iule-ac$or&E5a ple.4a"a+ mo"ule. 0hen ena,le", the ='e!ice "min= page 1ill ,e automatically a"Guste" to "isplay some o) these )iel"s. allo.No$)0& las$No$)0&T) e las$No$)0&7o(e no$)0&E a)l no$)0&Selec$or no$)0&Ac$)on no$)0&Oescr)p$)on no$)0&Su#4ec$ no$)0&Te5$ no$)0&Lse@rapper no$)0&Ar)or)$& par/e(,a$)$u(e par/e(,ong)$u(e par/e(Ia()us (in64ieldInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.,)n/-)el(8n0o!$rue These )iel"s are use" to store +%5 lin. in)ormation )or "isplaying on the 'e!ice map page Hsee =$rac/Map.s6o.Oe")ce,)n/= property in =pr)"a$e.5 l=I, an" possi,ly on email noti)ications Hi) con)igure"I. l)n/LI, l)n/Oescr)p$)on Data!ushInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.Oa$aAus68n0o!$rue These )iel"s are use" to store in)ormation regar"ing the last time 3!ent'ata recor"s 1ere sent to another system. las$Oa$aAus6T) e las$E"en$7rea$eM)ll)s 4i>ed(ocation4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.-)5e(,oca$)on-)el(8n0o!$rue These )iel"s are use" )or special applications 1here the *telematic* "e!ice "oes not ha!e a G6S recei!er an" 1here the asset ,eing monitore" "oes not mo!e Hie. Such as 1hen trac.ing 1ater tan. le!els in stationary tan.s, etcI. 0)5e(,a$)$u(e 0)5e(,ong)$u(e 0)5e(A((ress 0)5e(7on$ac$A6one 0)5e(Ser")ceT) e

OpenGTS Configuration and Installation Manual

Page 48 of 61

,orderCrossing4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.;or(er7ross)ng-)el(8n0o!$rue These )iel"s are use" )or storing state-line ,or"er crossing in)ormation. Hre?uires a mo"ule that can "etect stateline ,or"er crossings - currently not use" in the open-source EpenGTS systemIM #or(er7ross)ng las$;or(er7rossT) e GeoCorridor4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.Geo7orr)(or-)el(8n0o!$rue These )iel"s are use" )or storing the acti!e GeoCorri"or in)ormation Hcurrently not use" in the open-source EpenGTS systemI. ac$)"e7orr)(or MaintOdo"eter4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.Ma)n$O(o e$er-)el(8n0o!$rue These )iel"s are use" )or trac.ing perio"ic maintenance in)ormation Hcurrently not use" in the open-source EpenGTS systemI. a)n$8n$er"alPM2 a)n$O(o e$erPM2 a)n$8n$er"alPM1 a)n$O(o e$erPM1 a)n$8n$er"alHI2 a)n$EngHoursHI2 a)n$No$es Ior6OrderInfo 3on ig /ropertyM s$ar$up8n)$.Oe")ce.@or/Or(er8n0o!$rue These )iel"s are use" )or storing 0or.Er"er in)ormation an" miscellaneous custom )iel" in)ormation Hcurrently not use" in the open-source EpenGTS systemI. .or/Or(er8O cus$o A$$r)#u$es C %E Optional 1ser Ta/le Colu"ns: Address4ieldInfo 3on ig /ropertyM s$ar$up8n)$.Lser.A((ress-)el(8n0o!$rue These )iel"s are use" to store a""itional ""ress in)ormation, as speci)ie" ,y application re?uirements. a((ress,)ne1 a((ress,)ne2 a((ress,)ne3 a((ress7)$& a((ressS$a$e a((ressAos$al7o(e a((ress7oun$r&

OpenGTS Configuration and Installation Manual

Page 49 of 61

C 'E Optional &ventData Ta/le Colu"ns: Address4ieldInfo 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.A((ress-)el(8n0o!$rue These )iel"s are use" to store a""itional re!erse-geoco"e" ""ress in)ormation, as speci)ie" ,y application re?uirements. In or"er )or these columns to ,e )ille" in, the acti!e re!erse-geoco"e pro!i"er must ,e a,le to support these )iel"M s$ree$A((ress c)$& s$a$eAro")nce pos$al7o(e su#()")s)on spee(,) )$PAH )sTollIoa( G!S4ieldInfo 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.GAS-)el(8n0o!$rue These )iel"s are use" to store a""itional G6S an" mo"em attri,utes, such as accuracy, "ilution o) precision, signal strength, etc. gps-)5T&pe 6orGAccurac& "er$Accurac& HOOA sa$ell)$e7oun$ #a$$er&,e"el #a$$er&Vol$s s)gnalS$reng$6 Custo"4ieldInfo 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.7us$o -)el(8n0o!$rue These )iel"s are use" to store custom miscellaneous e!ent "ata )iel"s, such as "ri!er-i", generic analog !alues, etc. en$)$&8O (r)"er8O (r)"erS$a$us (r)"erMessage e a)lIec)p)en$ sensor,o. sensorH)g6 cos$7en$er 4o#Nu #er r0)(Tag a$$ac6T&pe a$$ac6Oa$a Gar"in4ieldInfo 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.Gar )n-)el(8n0o!$rue These )iel"s are use" tocollect 3T #Stop "ata )rom a Garmin 6ersonal Ja!igation 'e!ice H6J'I Ha "e!ice capa,ile o) sen"ing this in)ormation to the ser!er is re?uire"I. Hcurrently not use" in the open-source EpenGTS systemIM e$aT) es$a p e$aLn)Due8O e$aO)s$ancePM e$a,a$)$u(e e$a,ong)$u(e s$op8O s$opS$a$us s$op8n(e5

OpenGTS Configuration and Installation Manual

Page 50 of 61

CA?,1S4ieldInfo Dpreviousl$ *19=:4ieldInfo; as o) !2.3.2E 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.7AN;LS-)el(8n0o!$rue These )iel"s are use" to store engine "iagnostic in)ormation recei!e" )rom the on-,oar" engine "iagnostic computer. The engine "iagnostic in)ormation is usually o,taine" )rom the !ehicle ;1708, ;1:3:, E<'-II, or C J<+S inter)ace. This optional list inclu"es )iel"s such as =eng)neIAM=, =eng)neHours=, =coolan$,e"el=, =coolan$Te p=, =o)l,e"el=, =o)lTe p=, =0uel,e"el=, =0uelTo$al=, =0uel8(le=, an" many more Hsee the =7AN;LS-)el(8n0o= section in the 3!ent'ata.Ga!a source mo"ule )or a complete list o) supporte" )iel"sI. 0uelTo$al eng)neIp eng)neHours eng)ne,oa( eng)neTorDue )(leHours .or/Hours $ransO)lTe p coolan$,e"el coolan$Te p )n$a/eTe p #ra/eG-orce accelera$)on o)lAressure o)l,e"el o)lTe p a)rAressure a)r-)l$erAressure $ur#oAressure p$oEngage( p$oHours $6ro$$leAos #ra/eAos 41X2R-aul$ 0aul$7o(e al0unc$)on,a p 0uel,e"el 0uel8(le 0uelATO ";a$$er&Vol$s 0uelAressure 0uelLsage 0uelTe p 0uelEcono & #ra/eAressure $)reAressure $)reTe p At"osphere4ieldInfo 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.A$ osp6ere-)el(8n0o!$rue These )iel"s are use" to store atmospheric "ata, such as temperature an" ,arometric pressure. #aro e$er a #)en$Te p ca#)nTe p

OpenGTS Configuration and Installation Manual

Page 51 of 61

Ther"o4ieldInfo 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.T6er o-)el(8n0o!$rue These )iel"s are use" to store temperature in)ormation typically recei!e" )rom temperature monitors place" in the cargo ,eing transporte". $6er oA"erage2 $6er oA"erage1 $6er oA"erage2 $6er oA"erage3 Analog4ieldInfo 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.Analog-)el(8n0o!$rue These )iel"s are use" )or storing generic analog in)ormation. analoge2 analoge1 analoge2 analoge3 AutoIncre"entInde> 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.Au$o8ncre en$8n(e5!$rue These )iel"s are use" )or auto-in"e7ing the 3!ent'ata recor"s. +nless a,solutely re?uire", these )iel"s shoul" remain "isa,le". au$o8n(e5 &ndOfDa$Su""ar$ 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.En(O0Oa&Su ar&!$rue These )iel"s are use" to store the "aily summary "ata 1hich may ,e pro!i"e" ,y the remote G6S trac.ing "e!ice. &ost "e!ices 1ill not ,e a,le to pro!i"e this in)ormation Hcurrently use" only )or nt7 "e!ice communication ser!erI. (a&Eng)neS$ar$s (a&8(leHours (a&-uel8(le (a&@or/Hours (a&-uel@or/ (a&-uelATO (a&O)s$ancePM (a&-uelTo$al ServingCellTo7erData 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.Ser")ng7ellTo.erOa$a!$rue These )iel"s are use" to store the ser!ing cell-to1er in)ormation. This may ,e use)ul )or pro!i"ing a cell-to1er ,ase" appro7imate location Ha ser!ice 1hich can pro!i"e cell-to1er latitu"e#longitu"e location is re?uire"I. cellTo.er8O o#)le7oun$r&7o(e o#)leNe$.or/7o(e cellT) )ngA("ance loca$)onArea7o(e cellSer")ng8n0o cell,a$)$u(e cell,ong)$u(e cellAccurac& ?eigh/orCellTo7erData 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.Ne)g6#or7ellTo.erOa$a!$rue These )iel"s are use" to store the neigh,oring cell-to1er in)ormation. This may ,e use)ul )or pro!i"ing a cell-to1er ,ase" appro7imate location Ha ser!ice 1hich can pro!i"e cell-to1er latitu"e#longitu"e location is re?uire"I. cellNe)g6#or8n0o2 cellNe)g6#or8n0o1 cellNe)g6#or8n0o2 cellNe)g6#or8n0o3 cellNe)g6#or8n0oF cellNe)g6#or8n0oE
OpenGTS Configuration and Installation Manual

Page 52 of 61

OpenGTS Configuration and Installation Manual

Page 53 of 61

Ior6LoneGridData 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.@or/YoneGr)(Oa$a!$rue These )iel"s are use" to 0or.Uone "ata sampling in)ormation. Hnot use" in the open-source EpenGTS, an" in most GTS 3nterprise installationsIM sa ple8n(e5 sa ple8O CreationTi"eMillisecond 3on ig /ropertyM s$ar$up8n)$.E"en$Oa$a.7rea$)onT) eM)ll)secon(!$rue These )iel"s are use" to 3!ent'ata recor" creation time 1ith millisecon" resolution. This also creates a =(a$aAus6= )iel" 1hich can ,e use" 1ith the 'e!ice =Oa$aAus68n0o= optional )iel"s. (a$aAus6 crea$)onM)ll)s

OpenGTS Configuration and Installation Manual

Page 54 of 61

Appendi>E DE Installing MotoDMT!


D aE ?ote: The source )or the MotoDMT! G6S trac.ing support so)t1are is locate" in the OpenDMT! =client-G2me= proGect "o1nloa" )rom Source(orgeM httpsM##source)orge.net#proGect#sho1)iles.phpKgroup>i"W1$1031 The =MotoDMT!= application is "esigne" to 1or. 1ith &otorola i-1$#i-2$#i2:0#i33$ <oost &o,ile phones, an" may 1or. on other &otorola <oost &o,ile phones as 1ell. =MotoDMT!= uses the OpenDMT! protocol to sen" "ata to the OpenDMT! ser!er, 1hich is inclu"e" 1ith OpenGTS. &otorola <oost &o,ile phones are a!aila,le at !arious retail outlets in the +S, such as %a"io Shac., 0almart, Target, <est <uy, etc, an" may also ,e purchase" )rom <oost &o,ile "irectly. )ter purchasing one o) these &otorola <oost &o,ile phones, acti!ate ser!ice on the <oost &o,ile net1or. per the instructions that accompany the phone. &a.e sure that you select the "ata-plan ser!ice H= cti!ate 0ireless 0e,=I to ena,le the phone to sen" "ata to your ser!er. ?ote: OpenGTS/OpenDMT! an" GeoTele"atic Solutions; Inc are not a))iliate" 1ith &otorola or <oost &o,ile, or any o) the !arious mentione" retail outlets, in any 1ay. =&otorola=, =<oost &o,ile=, an" the !arious mentione" retail outlets are the registere" tra"emar.s o) their respecti!e companies. D /E I"portant: 0hen acti!ating <oost &o,ile ser!ice, ma.e sure you select the "ata-plan option Hchec. = cti!ate 0ireless 0e,=I to ena,le the phone to sen" "ata to the ser!er. D cE ?ote: Installing MotoDMT! re?uires the use o) 0in"o1s to run the &otorola =i'3J ;a!a pplication 5oa"er= application.

D 1E Configuring the MotoDMT! Gad file: precompile" !ersion o) =Mo$oOMTA.4ar= an" =Mo$oOMTA.4a(= is inclu"e" in this release. To ,uil" your o1n !ersion o) the =Mo$oOMTA.4ar= )ile, consult the MotoDMT! "ocumentation that accomanies the OpenDMT! *;a!a* implementation "o1nloa".. The ; ' )ile HMo$oOMTA.4a(I is use" to loa" runtime properties an" con)iguration in)ormation into the ;2&3 application. This )ile 1ill nee" to ,e mo"i)ie" prior to installation to con)igure the ser!erMport to 1hich "ata 1ill ,e sent, an" to con)igure the name Haccount, "e!ice, etcI use" to i"enti)y the phone on the ser!er. 3"it the =Mo$oOMTA.4a(= )ile using a con!enient te7t e"itor Hsuch as 0in"o1s =0or"6a"=I an" a"" the )ollo1ing property "e)inition to the last line o) the )ile Hor e"it the e7isting line, i) one is alrea"y presentIM OMTA-Access=+2B(MyServerHost>B(MyServer*ort>B(My0ccount34>B(My4evice34> 0hich speci)ies the ser!erMport, an" ccountI' # 'e!iceI' use" to i"enti)y the phone on the ser!er. HJoteM the pre)i7ing =0,= is re?uire" an" is reser!e" )or )uture useI. HJoteM The characters *B* an" *C* in the a,o!e e7amples ser!e to "elineate the !arious options an" are JET to ,e inclu"e" in the )inal property speci)ication. ; ' )ile property speci)ications shoul" ,egin at the )irst character in the lineI.

OpenGTS Configuration and Installation Manual

Page 55 of 61

(or e7ample, assuming that the host is =(a$a.e5a ple.co = an" the port is =31222=,an" the ccountI' # 'e!iceI' is =myaccount#my"e!ice=, a properly speci)ie" =OMTA-Access== line 1houl" appear as )ollo1sM OMTA-Access=+2B(a$a.e5a ple.co B31222B &accoun$B &(e")ce D 1aE I"portant: &a.e sure there is a ,lan. line at the en" o) the *Mo$oOMTA.4a(* )ile a)ter the last property entry. 0ithout this ,lan. line, the last property entry may not ,e loa"e" into the ;2&3 application, an" the phone may not ,e a,le to esta,lish a connection 1ith the ser!er. En the ser!er, a"" the account-i" an" "e!ice-i", to recei!e "ata )rom the phone. D #E Setting other configura/le event generation options: Oou can also set the reporting inter!al an" other con)igura,le options in the ; ' )ile as 1ell. Nere are some a""itional con)igura,le options that can ,e inclu"e" in the ; ' )ile to change the trac.ing ,eha!iorM HJoteM The characters *%* an" *M* in the e7amples ,elo1 ser!e to "elineate the !arious options an" are JET to ,e inclu"e" in the )inal property speci)ication. ; ' )ile property speci)ication shoul" ,egin at the )irst character in the lineI. OMTA-gps- )nsp(=+(MinimumMotionSpee+5*H> This option sets the minimum G6S reporte" spee" Hreplace =(MinimumMotionSpee+5*H>= 1ith the "esire" minimum G6S reporte" spee" in .m#hI. Spee"s reporte" ,y the G6S recei!er 1hich are less than this !alue 1ill ,e set to Aero ,e)ore reporting them in an e!emt. This helps mitigate the inaccuracies in G6S recei!ers that can report a *mo!ing* spee" e!en 1hen the G6S recei!er is stationary sitting on a "es.. The "e)ault minimum G6S spee" is 12 Dm#h Ha,out 7.- mphI. OMTA- o$-s$ar$=+(MinimumStartSpee+5*H> This option speci)ies the minimum spee" that must ,e reporte" ,e)ore a =Start &otion= e!ent is generate" Hreplace =(MinimumStartSpee+5*H>= 1ith the "esire" minimum *start* spee" in .m#hI. This !alue shoul" ,e at least as large as the !alue speci)ie" on the minimum G6S spee" a,o!e. The "e)ault !alue is 1/.1 .m#h Ha,out 10 mphI. OMTA- o$-)n o$)on=+(3nMotion3ntervalSecon+s> This option speci)ies the num,er o) secon"s ,et1een reporte" e!ents 1hile the phone is in motion, a)ter the generation o) a =Start &otion= e!ent Hreplace =(3nMotion3ntervalSecon+s>= 1ith the "esire" in-motion reporting inter!al in secon"sI. This !alue may not ,e less than /0 secon"s. The "e)ault !alue is 120 secon"s H2 minutesI. OMTA- o$-s$op=+(6ait7orStopSecon+s> This option speci)ies the num,er o) secon"s to 1ait a)ter the phone stops mo!ing to report a =Stoppe"= e!ent Hreplace =(6ait7orStopSecon+s>= 1ith the "esire" num,er o) secon"s to 1ait ,e)ore generating a =Stoppe"= e!entI. This !alue is use" to pre!ent ?uic. stop#starts )rom )re?uently occurring at stop-lights an" stop-signs, or short stops "uring hea!y tra))ic. The "e)ault !alue is 210 secon"s H3.$ minutesI. OMTA- o$-(or -ra$e=+(4ormant3ntervalSecon+s> This option speci)ies the num,er o) secon"s ,et1een reporte" e!ents 1hile the phone is not mo!ing Hie. ='ormant=I a)ter the generation o) a =Stoppe"= e!ent Hreplace =(4ormant3ntervalSecon+s>= 1ith the "esire" "ormant reporting inter!al in secon"sI. This !alue may not ,e less that 300 secon"s. The "e)ault !alue is 1800 secon"s H30 minutesI.

OpenGTS Configuration and Installation Manual

Page 56 of 61

OMTA- o$-e5spee(=+(/1cessSpee+T8res8ol+5*H> This option speci)ies the spee" threshol" in .m#h, ,eyon" 1hich an e7cess-spee" e!ent 1ill ,e gnerate" Hreplace =(/1cessSpee+T8res8ol+5*H>= 1ith the "esire" spee" threshol" in .m#hI. The "e)ault !alue is *0*, 1hich "oes not generate an e7cess spee" e!ent. D #aE I"portant: &a.e sure there is a ,lan. line at the en" o) the *Mo$oOMTA.4a(* )ile a)ter the last property entry. 0ithout this ,lan. line, the last property entry may not ,e loa"e" into the ;2&3 application, an" the phone may not ,e a,le to esta,lish a connection 1ith the ser!er.

D %E Installing the application on the phone: 'o1nloa" an" install the =i'3J ;a!a pplication 5oa"er= )rom &otorola, a!aila,le )rom this lin.M httpM##"e!eloper.motorola.com#"ocstools#i"enGal# This application installs on 0in"o1s 96 or 2ista. %e)er to the a,o!e 1e,site )or a""itional "etails regar"ing system re?uirements an" installation proce"ures. +S< ca,le Htype -male to &ini-<-maleI 1ill ,e nee"e" to connect your i-2$#i2:0 phone to your 0in"o1s 6C Hthe i-1$ phone re?uires a custom ca,le a!aila,le at your Sprint#Je7tel storeI. Oou may also nee" to "o1nloa" the +S< "ri!er )or &otorola han"set, 1hich can ,e o,taine" )rom the )ollo1ing lin.M httpM##"e!eloper.motorola.com#"ocstools#+S<>'ri!ers# 5oa"ing &oto'&T6 onto your phone using Epen; 5M 1I 6lace ,oth the =Mo$oOMTA.4ar= an" =Mo$oOMTA.4a(= in the same "irectory. 2I Start up Epen; 5 an" con)igure the pre)erences to =Connect !ia +S< connection=. 3I 6lug in the phone to your 6C using the +S< ca,le. -I Select =Connect To 6hone=. 0ithin a )e1 secon"s it shoul" connect to the phone an" 1ill in"icate a re" =9=o!er the =Connect To 6hone= icon. $I Select =5oa" ;2&3 pplication=, then ,ro1se to the =Mo$oOMTA.4a(= )ile. /I Select ='o1nloa"=. 0ithin a )e1 secon"s the "o1nloa" shoul" ,e complete H1hile it may appear that only the =Mo$oOMTA.4a(= )ile is ,eing "o1nloa"e", it is in )act loa"ing ,oth the =Mo$oOMTA.4a(= an" =Mo$oOMTA.4ar= )iles to the phone.I 7I Ence uploa"e", clic. the ='isconnect phone= ,utton 1ithin the Epen; 5 application. 'i))erent phones ha!e "i))erent metho"s )or installing#up"ating#starting ;a!a applications. The )ollo1ing "escri,es a rough o!er!ie1 o) the process, ,ut the comman"s on your particular phone may ,e "i))erentM Installing the &oto'&T6 application once "o1nloa"e" to the phoneM 1I (rom the main phone screen H1ith the =<oost mo,ile= logoI, select the menu ,utton an" tra!erse to the =;a!a pps= or =GamesX pps= icon, then press ED. 2I I) it as.s to install the ne1 "o1nloa"e" app, select =Oes=. Ether1ise tra!erse to the =&oto'&T6= application an" press the menu ,utton. I) an up"ate is a!aila,le, select =+p"ate= an" go through the up"ate process. To start the application, select ED. Starting the &oto'&T6 applicationM 1I Tra!erse to the =&oto'&T6= application an" press =ED=. 2I I) any ?uestions are as.e" regar"ing access to the phones resources HG6S, "ata transmission, etcI, al1ays ans1er yes#o.#al1ays#etc.

OpenGTS Configuration and Installation Manual

Page 57 of 61

Oou can also set up the phone to automatically start the &oto'&T6 application 1hen the phone is turne" onM 1I (rom the main phone screen, select the menu ,utton, then select =Settings=, then select =6ersonaliAe=. 2I Tra!erse to the =6o1er +p= option an" press the ED ,utton. 3I = ppM ...= 1ill ,e selecte". 6ress the ED ,utton. -I Tra!erse to the =&oto'&T6= option an" press the ED ,utton. $I Continue selecting =<ac.= until the main screen is "isplaye".

I"portant: The G6S recei!er in the phone may not )unction i) the phone "oes not ha!e current acti!e ser!ice through <oost &o,ile. s a result, the 5atitu"e#5ongitu"e may not "isplay properly on the phone i) <oost &o,ile ser!ice is not acti!e.

D 'E Application ?otes: )ter starting the application, the screen 1ill appear as )ollo1sM T8M=+n/a ,AT=+n/a ,ON=+n/a A77=+9/-+2+0$ SAO=+2+ p6 A,T=+2+0$ EVT=+2/2 GAS+AcDu)re+... HJoteM i) =Access &rror= is "isplaye", then the =OMTA-Access= property 1as not con)igure" properly in the =Mo$oOMTA.4a(= )ile. Congigure the =OMTA-Access= property as "escri,e" a,o!e an" reloa" the application to the phone. &a.e sure there is a ,lan. line at the en" o) the =Mo$oOMTA.4a(= )ileI. Ence the )irst G6S )i7, the screen 1ill appear similar to the )ollo1ingM T8M=+12=2F=2X ,AT=+3Z.123F ,ON=+-1F2.123F A77=+9/-+22+0$ SAO=+2+ p6 A,T=+1X+0$ EVT=+2/2 The "isplaye" )iel"s are "escri,e" as )ollo1sM T8M+- The current time ,AT+- The current latitu"e ,ON+- The current longitu"e A77+- The *accuracy* o) the current G6S )i7 SAO+- The current spee" A,T+- The current altitu"e EVT+- The num,er o) e!ents transmitte" # the num,er o) e!ents ?ueue" to transmit

OpenGTS Configuration and Installation Manual

Page 58 of 61

Appendi>E &E I"porting G!S &vents fro" the Trac6Stic6 Mini


%this eature is available in the v8.9.8 release o (pen3) &

The =Trac.Stic. &ini= is a G6S "ata logging "e!ice a!aila,le )rom =Trac.Stic.=. &ore in)ormation can ,e )oun" on their 1e,site at =6$$p=//....$rac/s$)c/.co /pro(uc$s/ )n)/)n(e5.6$ l=. ?ote: OpenGTS an" GeoTele"atic Solutions; Inc are not a))iliate" 1ith Trac.Stic. or Telespial Systems, in any 1ay. =Trac.stic.= an" =Trac.stic. &ini= are the registere" tra"emar.s o) Trac.stic. an" Telespial Systems. The =Trac.Stic. &anager= can e7port G6S logging in)ormation in CS2 Hcomma-separate"-!alueI )ormat. This e7porte" CS2 )ile can then ,e importe" into OpenGTS to "isplay the !arious capture" locations on a map. 'uring the import to OpenGTS, the "ata points can ,e )iltere" to inclu"e only points that ha!e "irection changes or are more than a certain num,er o) secon"s apart, thus re"ucing the num,er o) unecessary "ata points. The re?uire" con)iguration use" 1hen e7porting the CS2 )ile is as )ollo1sM Date/Ti"e L ll o) the a!aila,le "ate#time )ormats that the Trac.Stic. &anager supports are also supporte" ,y the OpenGTS CS2 import utility, ho1e!er the ='isplay Secon"s= ,o7 must also ,e chec.e". ,ecommended: Date in $##4664::::$ ormat, and )ime in a separate column in 8;7hour ormat as $hh:mm:ss$. Ti"e2one L 37porting the "ata in G&T timeAone is recommen"e", ,ut the timeAone o) the e7porte" "ata can ,e speci)ie" on the OpenGTS CS2 import. ,ecommended: G#T. (atitude/(ongitude L ll o) the a!aila,le latitu"e#longitu"e )ormats that the Trac.Stic. &anager supports are also supporte" ,y the OpenGTS CS2 import utility, ho1e!er the =2isi,le= ,o7 must also ,e chec.e". ,ecommended: degrees. Altitude L The altitu"e units must ,e in meters. The =2isi,le= ,o7 must ,e chec.e". Te"perature L The temperature units must ,e in "egrees Celsius. Speed L The units shoul" ,e in =.ph= H.m#hI, ho1e!er =mph= an" =.ts= shoul" 1or. as 1ell as long as this unit speci)ication is "isplaye" a)ter the spee" !alue. ,ecommended: "m4h. Status DdurationE L The selecte" units must ,e in =minutes=. Course L The course#hea"ing units must ,e in "egrees Hre?uire" )or hea"ing change )ilteringI. The =2isi,le= ,o7 must ,e chec.e". +Displa$ G!S 4i>+ ,o7 must ,e chec.e". +Displa$ Signal+ ,o7 must ,e chec.e". +Displa$ !o7er On/Off Records+ ,o7 must ,e chec.e". & 1E Configuring &vent 4iltering: The import process can )ilter e!ents to retain only those that are pertinent. The )ollo1ing runtime con)iguration properties can ,e set to speci)y the type o) )iltering that shoul" occur 1hen importing the G6S logging "ata Hthese properties shoul" ,e speci)ie" in the =con0)g.con0= )ileIM tr,68st'68.A'n'A0AHe,2'n*C4,n*e This property speci)ies the minimum "etecte" hea"ing change in or"er to accept a "ata point )or inclusion into the 3!ent'ata ta,le. larger num,er 1ill re"uce the num,er o) inclu"e" e!ents. smaller num,er 1il pro"uce a smoother route line aroun" turns. ,ecommended value: <=.> %degrees& tr,68st'68.A'n'A0AMo-'n*Se6on2s This property speci)ies the minimum num,er o) secon"s ,et1een perio"ic "ata points 1hen the !ehicle is in motion. ,ecommended value: <8> %seconds& tr,68st'68.A'n'A0A.orA,ntSe6on2s This property speci)ies the minimum num,er o) secon"s ,et1een perio"ic "ata points 1hich may occur 1hen the !ehicle is not mo!ing. ,ecommended value: <?>> %seconds&

OpenGTS Configuration and Installation Manual

Page 59 of 61

tr,68st'68.est'A,teO2oAeter This property speci)ies 1hether or not to calculate a G6S-,ase" o"ometer !alue ,et1een successi!e points. The o"ometer starting point is o,taine" )rom the =las$O(o e$erPM= )iel" in the 'e!ice recor", an" the )inal o"omter !alue is store" ,ac. into the 'e!ice =las$O(o e$erPM= )iel". Since the starting o"ometer is retrie!e" )rom the 'e!ice recor", an" en"ing o"ometer is store" ,ac. into the "e!ice recor", it is possi,le that attempting to import a CS2 )ile more than once may s.e1 the o"ometer !alues entere" into the 3!ent'ata ta,le. The import process "oes attempt to "etect an attempt to re-import the same CS2 )ile, to mitigate any =s.e1ing= e))ect that may occur, ho1e!er care shoul" ,e ta.en to a!oi" re-importing the sa!e CS2 )ile i) possi,le. ,ecommended value: true & #E Running the I"port Co""and: ssuming that the name o) your e7porte" CS2 )ile is calle" =2211-23-21+2F.2E.12.cs"=, the comman" to import the CS2 )ile into OpenGTS 1oul" ,e as )ollo1sM
c(+$GTS_HOME #)n/$rac/s$)c/.s6+-accoun$!ACCOUNT+-(e")ce!DEVICE+-$ G!TIMEZONE+-cs"!<2211-23-21+2F.2E.12.cs"<

Er on 0in"o1sM
c(+%GTS_HOME% #)nH$rac/s$)c/.#a$+-accoun$=ACCOUNT+-(e")ce=DEVICE+-$ G=TIMEZONE+-cs"=<2211-23-21+2F.2E.12.cs"<

0here =ACCOUNT= an" =DEVICE= are the account#"e!ice to 1hich the importe" "ata 1ill ,e applie", an" =TIMEZONE= is the timeAone o) the times represente" 1ithin the CS2 )ile. HJoteM =-a=ACCOUNT+-(=DEVICE= may also ,e use" to speci)y the account an" "e!iceI. Set the =-cs"= )ile to the name o) the )ile e7porte" )rom the =Trac.stic. &anager=. The comman" 1ill then output hea"er in)ormaton in"icating the !alues o) the e!ent )iltering as )ollo1s Hthe !alues "isplaye" ,elo1 are only an e7ample o) the !alues that may ,e "isplaye"IM
--------------------------------------------Accoun$++++++++++=+(e o Oe")ce+++++++++++=+(e o Oe#ug+Mo(e+++++++=+0alse Oe0aul$+T) eGone+=+GMT M)n+Spee(+P /H+++=+2.2 M)n+Hea()ng+76g++=+1E.2 M)n+Mo")ng+Sec+++=+122 M)n+Oor an$+Sec++=+1R22 Es$) a$e+O(o e$er=+$rue ---------------------------------------------

(ollo1e" ,y a "isplay o) each e!ent parse" an" inserte" into the 3!ent'ata ta,leM
... --------------------------------------------8nclu(e+E"en$=+$rue+-+S$ar$+E"en$+V/p6W T) es$a p++++=+'13212122R2*+T6u+Mar+2F+1X=1R=22+AOT+2211 S$a$us+++++++=+S$ar$ GeoAo)n$+++++=+3Z.2E2EF/-1F2.33E2R Al$)$u(e+++++=+E12.X+ e$ers+V1RF1.1+0ee$W Spee(++++++++=+F.2+/ /6+V2.E+ p6W+6ea()ng+33X.1+VNor$6W Te p+++++++++=+2R.F+7+VR3.1+-W O(o e$er+++++=+2.2+/ +V2.2+ )lesW S$ore(+E"en$+=+'25-111*+S$ar$

OpenGTS Configuration and Installation Manual

Page 60 of 61

--------------------------------------------8nclu(e+E"en$=+$rue+-+Aer)o()c+Mo")ng+E"en$ T) es$a p++++=+'1321212E22*+T6u+Mar+2F+1X=22=22+AOT+2211 S$a$us+++++++=+8nMo$)on GeoAo)n$+++++=+3Z.2E2E2/-1F2.33E2R Al$)$u(e+++++=+E1F.E+ e$ers+V1RE2.2+0ee$W Spee(++++++++=+2.2+/ /6+V2.2+ p6W+6ea()ng+12.2+VNor$6Eas$W Te p+++++++++=+2R.Z+7+VRF.2+-W O(o e$er+++++=+2.2+/ +V2.2+ )lesW S$ore(+E"en$+=+'25-112*+8nMo$)on --------------------------------------------...

I) the option =-nosa"e= is a""e" to the comman"-line, then the "ata parsing 1ill occur, ,ut the 3!ent'ata recor"s 1ill not ,e store", nor 1ill any o"ometer in)ormation ,e up"ate" in the 'e!ice recor". +sing =-nosa!e= is usually recommen"e" )or the initial chec. o) the "ata to ma.e sure that the timeAone has ,een speci)ie" properly Hother1ise the time may ,e o)) ,y se!eral hoursI. & %E Capturing the Device Te"perature Infor"ation: The temperature in)ormation can also ,e store" into the 3!ent'ata ta,le, pro!i"e" that the )ollo1ing optional =T6er o-)el(8n0o= 3!ent'ata )iel" set has ,een ena,le" Hcon)igure" in =con0)g.con0=IM s$ar$up8n)$.E"en$Oa$a.T6er o-)el(8n0o!$rue Then up"ate the 3!ent'ata ta,le columnsM c(+$GTS_HOME #)n/(#A( )n.pl+-$a#les!ca The =repor$s.5 l= )ile can then ,e mo"i)ie" to "isplay the temperature !alues on one o) the 3!ent'etail reports.

OpenGTS Configuration and Installation Manual

Page 61 of 61

You might also like