View source for Pandora: Documentation en: GIS

[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]

= The Pandora GIS =

== Introduction ==
A GIS map is a visual representation of the location of the agents inside the Pandora FMS installation. With this map we can see the current position, as well as a small history of the agents positions.

To be able to use the GIS maps, you must have configured the agents, the server and the console.

== Setup ==

=== Agent configuration ===

The software agent pandora_agent.conf file contains parameters to configure the device's position: longitude, latitude, altitude and position description. The 'gis_exec' parameter can also be used, where the path of the script that returns the coordinates of a device by means of a string with the "latitude, logitude, altitude" format must be indicated.

This is an example:
 
 # Agent position parameters
 # Those parameters define the agent's geographical position. 
 
 # gis_exec: Calls a script that returns a string with '[latitude],[longitude],[altitude]'
 # i.e.: 41.377,-5.105,2.365
 
 #gis_exec /tmp/gis.sh
 
 # latitude 
 latitude 42.70456
 # longitude
 longitude -3.897187 
 # altitude
 altitude 600
 
 # Position description
 position_description Madrid, centro

=== Server configuration ===

GIS features must also be enabled on the server, enabling the 'activate_gis' parameter. If this flag is set to '1', the server will process all GIS information received from the agents.

There is also the new feature of storing agent positions on Pandora FMS. But this data comes from a source that is not highly accurate and it can cause for an agent with no significant position changes to send location change information. To avoid this, the 'location_error' parameter fixes the distance which is considered to be the same location. This is an error tolerance pn the position threshold and while the agent location continues to be within that range, it is considered that there has been no position change.

''' Discovery server and position information:'''

By using a reverse geolocation algorithm and a database, containing the relation of IPs and positional information, the Discovery server is now able to 'calculate' the position of the discovered agents. It can use a file in [http://www.maxmind.com/app/geolitecity '''MaxMind GeoIP GeoLiteCity'''] format or a couple of tables on the database containing this particular information.

There are also two parameters which define this particular Discovery server performance. The ''recon_reverse_geolocation_file'' is only used to point to the file which contains the reverse geolocation information by using the 'MaxMind GPL GeoLiteCity.dat' format and the 'recon_location_scatter_radius' parameter. The algorithm will calculate an approximated position for the agents and they will be  randomly placed around the calculated positions, taking into account the indicated 'recon_location_scatter_radius' radio.

You may also use the reverse geolocation provided by the Google API and OpenStreetMaps. You may activate Google's reverse geolocation by setting the parameter named 'google_maps_description' to '1'. Be careful when using this feature, because it '''considerably decreases the Pandora FMS server's performance'''. Please keep in mind that you're required to have a direct '''connection to the Internet''' to use Google's API and Openstreet Maps. It also heavily depends on the service provider's availability.

'''Configuration Example:''' 
 # Flag to activate GIS (positional information for agents and maps). It's deactivated by default.
 activate_gis 1
 
 # Radius of the Error in meters to consider two GIS locations as the same location.
 location_error 10
 
 # Recon reverse geolocation file (databases containing the reverse geolocation information using
 # the 'MaxMind GPL GeoLiteCity.dat' format).
 # Comment it to disable the IP geolocation on agent creation.
 
 recon_reverse_geolocation_file /usr/local/share/GeoIP/GeoLiteCity.dat
 
 # Radius (in meters) of the circle in which the agents will be place randomly when found by a recon task.
 # The center of the cycle is guessed by geolocating the IP.
 recon_location_scatter_radius 1000
 
 # This enables real time reverse geocoding using the Google Maps public API.
 # This requires internet access and could have performance penalties because of having to process GIS
 # information due the connection required to resolve all GIS input.
 
 google_maps_description 1
 
 # This enables real time reverse geocoding using OpenStreetMaps public API.
 # This requires internet access and could have performance penalties because of having to process GIS
 # information due the connection required to resolve all GIS input.
 # You may alter the code to use a local or your own OpenStreetMaps server.
 
 openstreetmaps_description 1

There is a plugin that recalculates agent GIS localization. The plugin path is ''/usr/share/pandora_server/util/agent_gis_update.pl'' by default,
but it can be place wherever the user prefers.

''' Use example:''' 

 /usr/share/pandora_server/util/agent_gis_update.pl /etc/pandora/pandora_server.conf

The default path of the plugin is ''/usr/share/pandora_server/util/agent_gis_update.pl'', but you can locate it wherever you want.

<br><br>
<center>
[[Image:Ejemplo_GIS.png‎]]
</center>
<br><br>

=== Console setup ===

To use GIS features, they must have been previously activated in the main setup in Pandora FMS console.

<center>
[[Image:Enable_GIS.png‎]]
</center>

Once activated, the following new user interface sections become available:

In Setup -> GIS map connection, define the connections that can be used with map servers to provide maps for GIS features.

==== GIS Connections ====

===== Basic Configuration ===== 

The connection comes with several basic parameters:

<center>
[[Image:‎Connection_configuration_basic.png|800px]]
</center>


* A '''name''' for the configuration, so it can be recognized when selecting a connection on the map definition screen.
* The '''group''' the connection belongs to.
* The '''number of zoom levels''' defined on the map.
* The '''default zoom level''' recommended for the map (this can be redefined on the map) and it is the zoom in level used when the map is open.

Once the basic parameters are set, the administrator is required to select a connection type. Depending on the type, there will be different options, and so are the types of connections and their options.

===== OpenStreet Maps =====

The default Pandora FMS installation comes with a predefined connection with [http://www.openstreetmap.org/ '''OpenStreetMaps'''] so the users are able to directly see and test the GIS features. 

In order to use an Open Street Maps type of map, the only parameter required is the URL of the '''title server''', as shown on the image below.

<center>
[[Image:‎Connection_configruation_openstreetmaps.png|800px]]
</center>

This could be something similar to:
 http://tiles.example.com/${z}/${x}/${y}.png

===== Google Maps =====

Pandora FMS also supports the connection to Google Maps. For that purpose, obtain a valid password for 
Pandora FMS Console server from Google (see [https://developers.google.com/maps/documentation/directions/#api_key '''Google Maps API Policy''']) and place it on the corresponding field of the connection definition.

<center>
[[Image:‎Connection_configruation_goole.png|800px]]
</center>

By means of this password, it is possible to define several connections using different base map types, e.g. 'Hybrid', 'Physical' or 'Satellite'.


{{Tip|This password might take a couple of minutes to work after having obtained it.}}

===== Static Image =====

Another type of supported connection is to use a Static Image as a map. In order to use this type of map, the image is required to be as a [http://en.wikipedia.org/wiki/EPSG:4326 EPSG:4326].

In this case, the parameters required for defining the map are the image URL, the image's height and width and the positional limits ('longitude' and 'latitude') of the image's edges ('right', 'left', 'top' and 'bottom').

<center>
[[Image:‎Connection_configruation_static_image.png|800px]]
</center>

=====WMS Server=====

Sometimes Pandora FMS server is located somewhere without direct Internet connection, so it is not possible to use an online map service. Some other times, the user might prefer their own map server to achiever higher flexibility, work faster, or define his own mosaic types. From version 7.0 Build 723 onwards, it is possible to add connections to WMS servers (Web Map Service), like [http://geoserver.org/ GeoServer]. To do this, enter the address where the service is provided and the name or names of the layers you wish to get from it.

<br><br>
<center>
[[Image:gis-connection-wms-server.png]]
</center>
<br><br>

For a minimum Geoserver server installation and configuration, see [[Pandora:Documentation_en:GeoServer_Installation|this annex]].

=====Map center and default position=====

The last thing to define for a map connection is the map center and the default position for agents without any positional data. In order to define them, it is possible to preview the map and click on it to set this parameters, depending on which parameter is selected by the 'Change in the Map' selector.

Within this preview map, it is possible to move around by using the green arrows on the top left, change the zoom level with the '+' and '-' icons or use the 'magnifier' to use zoom in.

Of course, it is also possible to set the position by inserting the values into the corresponding input boxes.

<center>
[[Image:‎Connection_configruation_set_center_default.png]]
</center>

Once all connection parameters are set, it is possible to save the connection in order to use it on the map builder by clicking on the 'Save' button.

====  GIS Maps ====

Once the connections are defined, they may be used to define the maps within the '''GIS Maps ''' menu.

<center>
[[Image:‎Gis_map_menu.png | 500 px]]
</center>

The menu takes the user to a screen with defined maps, where it is possible to edit a map, view it, set it as default or delete it.

There is also a button to create new maps.
<br>
<br>
{{Warning|It '''is required''' to set a default map which will be used in the agent's view to display its position.}}

===== Creating a GIS Map =====

Once on the map creation page, the first thing to do is to add a '''map name''' and a '''map connection''' from the ones available. You may add more than one, which will be available later on as base layers (only one of them can be active at once). When the connection is selected, or if the default connection for the map is changed, the Pandora FMS Console will ask whether you intend to use the default data from the connection for the map. If the answer is 'Accept', the console will fill out or update '''all positional data''' with the ones defined in the connection, and the user will just set the default zoom in level. If use of the default values is denied, '''no changes will be made''' and the connection will just be added.

<center>
[[Image:Gis_map_builder_main.png‎|800px]]
</center>

===== Layer definition =====

Once the basic map parameters are set, it is time to define the map's layers used to select which elements are shown on the map - except if it is the default map - on which there is no need to define any layer, because it will be used to display the agent's position in the agent view.

Each map has one or more layers to display agents. Each layer was designed to display the ''group agents'', ''a list of agents'' and/or ''a group with an agent as a sample''. That way, it is easy to define the agents shown on each layer.

The layers can be defined as ''visible'' or ''hidden'' and it is possible to: 

<br><br>
<center>
[[Image:GIS_grupo.png]]
</center>
<br><br>
* Choose the group with the selector to add agents.

* Add each agent manually.

* Add a group with only one agents as sample.

{{Tip|Once you have created a group in a layer with its representative agent, you cannot generate the same group with another agent.}}

Once the layer is defined (it is not completely saved until the complete map is), it will be moved to the left column of defined layers, in which it is possible to arrange (move them up or down), delete or edit them again. 
 
Once the map layer definition is complete, it is saved by clicking on the 'Save Map' button ('Update Map' button in case the map was edited instead).

== Operation ==

Once there is at least one map defined, it is possible to start using GIS features.

=== GIS Maps ===
The GIS map menu displays all defined maps. Each one can be viewed by displaying the map with the parameters defined in the map.

==== Moving around on the Map ====

The controls for the map include four green arrows on the top left corner which allow to move around on the map. The '+' and '-' icons are intended to increase and decrease the zoom level. There is also a 'zoom bar', designed to directly select the desired zoom level.

It is also possible to move around by dragging the map to the desired position.

Click on the agents shown on the map to have more information about the agent displayed (once the extra information is displayed, the agent's name becomes a link to the agent's view).

==== Hide, show and select Layers ====

The white '+' icon at the right opens the layer's controls. It displays a green box in which it is possible to select the base layer (the connection to the map's server, if there were more than one are defined for that map) and see which layers are '''visible'''.

There is also a special system-defined layer called '''Agent Hierarchy'''. If this layer is visible, it will display some red dashed lines, connecting an agent to its parent element (if both of them are visible).

==== Filters ====
 
Above the map there are filtering options for the agent states:
* Ok
* Critical
* Warning
* Other

==== Map Refresh ====

Next to the filter buttons, there is a combo box called '''Refresh''' to select the map update rate. The map uses [[http://en.wikipedia.org/wiki/AJAX '''AJAX Calls''']] to refresh the agents on the map by using the defined period.

==== Map edit and full screen ====

The last three buttons on the map's top right is a link to the Public Visual Console, a link to '''GIS Map Builder''', intended for editing the map and a full-screen button to see the map in '''full-screen mode'''.

<center>
[[Image:Gis_maps_default_all_controls2.png|800px]]
</center>

=== Agent View ===

The Pandora FMS console agent view also comes with new GIS features. The main view now displays the agent location in terms pf longitude, latitude and altitude.

==== Historical GIS view ====

There is a new button on the top bar to display the agent's '''GIS view''' (if GIS is enabled).
 
This view displays the agent's current position on the '''default map'''. It contains a table that shows the history of the agent's previous positions and their route on the map.

Each position on the map is represented by a dot (except the current one which is represented by the agent's icon). It is possible to click on any of these dots in order to get position-related information. It is also possible to click on the agent's icon in order to display the agent's current information. The following information shows the way covered by the Pandora FMS agent for Android devices.

<center>
[[Image:Pandroid_GIS22.png|800px]]
</center>

You are also able to display a table which contains all the agent's reported information, including a reverse geolocation system which was designed to display the agent's address including the street, city and country in which the Pandora FMS agent is located.

<center>
[[Image:Pandroid_GIS23.png]]
</center>

=== The Agent's GIS Setup ===

Among the agent's administration tabs, there is a new tag to manually set the agent's position. The 'agent manage' tab also has some parameters which affect the GIS features.

==== Ignoring GIS Data ====

On the 'agent manage' tab, there is a new switch called 'Ignore GIS data'. If this switch is activated, the server will ignore all positional information received from the agent and use the last valid values for it. This is useful in case an agent reports a wrong position or it gets its own fixed place.

<center>
[[Image:Agent_management_icon_ignore_gis_data2.png]]
</center>

==== Manual agent position ====

The 'GIS Data' view displays the default map on which it is possible to click on the agent in order to define the agent's new position. It is also possible to determine the position by using the input boxes below the map.

<br><br>
<center>
[[Image:Pos_manual.png]]
</center>
<br><br>

{{warning|Defining the agent's position will activate the''' 'Ignore GIS Data' ''' option in order to avoid the agent's next positional information data package to reset the agent's position again. If this is '''not''' the desired performance, we recommend deactivating the 'Ignore GIS Data' switch before clicking on the 'Update' button.}}

== Useful links ==

This is a collection of interesting links which are quite useful for implementing test environments and development with OpenLayers.

=== OpenLayers ===

* Wikipedia page about [http://en.wikipedia.org/wiki/OpenLayers OpenLayers]
* Openlayer documentation made by using [http://www.naturaldocs.org Natural Docs] [http://dev.openlayers.org/docs/files/OpenLayers Openlayers Documentation]
* More information about Openlayers [http://docs.openlayers.org/library/feature_styling.html Official documentation about styles]
* Help with OpenLayer styles: [http://trac.openlayers.org/wiki/Styles OpenLayers Styles]
* Debugging by Firebug [http://openlayers.org/dev/examples/debug.html OpenLayers Debug]

=== OpenStreetMap ===

* [http://wiki.openstreetmap.org/wiki/OpenLayers Some examples of OpenLayers]
* [http://wiki.openstreetmap.org/wiki/Using_OpenStreetMap Using OpenStreetMap]
* File download [http://planet.openstreetmap.org/ OSM]
* [http://wiki.openstreetmap.org/wiki/Osm2pgsql Osm2qgsql]

=== OS Geo ===

* [http://www.osgeo.org/ The Open Source Geospatial Foundation ]

=== Geo Server ===

* Main website [http://geoserver.org geoserver.org] 
* [http://geoserver.org/display/GEOS/Stable Stable version]

=== PostgreSQL ===

* Documentation for GIS extensions for [http://www.postgresql.org/docs/8.1/interactive/index.html PostgreSQL 8.1]

[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]

[[Category:Pandora FMS]]