View source for Pandora: Documentation en: Data Presentation/Visual Maps

== Visual Maps ==

Pandora FMS allows you to create visual maps in which each user is able to create his own monitoring map.

The new visual console editor is much more practical, although the old visual console editor had its advantages. Within the new visual console, we've been successful in imitating the sensation and touch of a drawing application like [http://www.gimp.org/ '''GIMP''']. We've also simplified the editor by dividing it into several subject-matter tabs named 'Data', 'Preview', 'Wizard', 'List of Elements' and 'Editor'.

The elements the Pandora FMS Visual Map was designed to handle are 'static image', 'percentage bar', 'module graph' and 'simple value'.

=== Creating a Visual Map ===

In order to create a visual map, please click on 'Topology Maps' and 'Visual Console'. It's going to display a list, containing all the maps created so far. In order to create a new map, please click on the 'Create' button.

<center>
[[image:pre54.png|900px]]
</center>

The picture below shows a window intended to name the map. Please pick a group and select the map you intend to use. Once you have filled out all the appropriate fields, please click on the 'Create' button.

<center>
[[image:pre55.png|900px]]
</center>

=== Viewing a Visual Map ===

In order to inspect all visual maps which have been created so far, please click on 'Reporting' and 'Visual Console'. It's going to display a list which contains all maps created so far.

The visual console items come with the following characters: "'''_'''", "''','''" , "'''['''" and "'''('''". For the first letter, it's shown in the left menu within the 'Visual Console' sub menu.

<center>
[[image:pre73.png|900px]]
</center>

In order to see the map, please click on the map's name you intend to inspect.

<center>
[[image:pre74.png|750px]]
</center>

Below the map, there is a combo which was designed to pick the map's appropriate refresh time. The map can be viewed in full-screen mode by clicking on this icon [[image:pre75.png]]. It's also possible to go to the map's editing page by clicking on this icon[[image:pre76.png]]. It's also possible to display a public link to the current visual map which is accessible without having to login into the Console. [[image:pre76_b.png]]

=== Deleting a Visual Map ===

In order to delete a visual map, please click on 'Topology Maps' and 'Visual Console'. It's going to display a list in which all maps created so far are contained. In order to delete a map, please click on the trashcan icon in the row of the visual map you intend to delete.

<center>
[[image:pre77.png|750px]]
</center>

=== Tabs in the Visual Map Editor ===

==== Data ====

Within the data tab, you may edit and create the visual console's basic data. There is only one visible for a new map until you save it. The essential values within this particular tab are the visual console's name, the group for the ACL management and the background image.

By creating it, the size of the visual console is determined by the background's image size. If you change the background, the last user-defined size or the previous background will be stored.

The background images are stored within the Pandora Console directory under 'var/www/pandora_console' in the '/images/backgrounds/' directory.

<center>
[[image:Pandora new visual console, tab data.png|750px]]<br />
''Example of the data tab's layout.''
</center>

==== Preview ====

The visual console view is a static view, so if the state of the elements contained in there changes, they're '''not''' going to be drawn again. Same as the visual console's view which is contained in Visual Console's menu.

<center>
[[File:Pandora new visual console, tab preview.png|800px]]<br />
</center>

==== The Wizard ====

In here is a small questionnaire to create several elements of the static-image type simultaneously within the visual console by only two clicks.

As you can see in the picture below, the form consists of the following:

* The image which will be the same for all the elements created in the batch.
* The distance between the elements, that will be one after another in a horizontal line from position '0,0'.
* The agent's selection box to select one or several agents. Whether you select one or several agents, the batch elements will be created for the visual console.
* The module's selection box, which is a dynamically designed control which is filled by the agent's modules you've picked within the agent's selection box. You're able to pick the modules for which you intend the static image elements in the visual console to be drawn in it.

<center>
[[File:Pandora new visual console, tab wizard.png|750px]]<br />
''Example of the Wizard tab.''
</center>

====Services Wizard====
<br>
{{tip|This feature is belongs to the '''Pandora FMS Enterprise''' version.}}

The services wizard contains a small questionnaire to create several service elements into the visual console by a few clicks clicks.
The selected services will appear placed automatically into the visual console with the chosen icon.

<center>
[[File:Pandora new visual console, tab services wizard.png]]<br />
''Screenshot of the services wizard tab.''
</center>

==== List of Elements ====

This tab provides a questionnaire for the visual console which you're presently editing. It's tabulated in files of the elements and a quick way of editing the different elements. It's also a useful tool for users which require to adjust certain element's values.

The supported actions within this questionnaire are editing and the deletion of elements. Creating elements and changing the element's type is '''not''' supported here. These actions are required to be carried out under the 'Editor' and 'Create' tabs.

The first line is the background image's configuration.

The rest of the lines are going to be map elements, associated in lines of two elements each and separated by a horizontal black line as shown on the picture below.

<center>
[[Image:Pandora new visual console, tab list elements.png|600px]]<br />
''An example for the 'List of Elements' tab.''
</center>

==== The Editor ====

This tab contains the most of the visual console editor's functionalities, because this is the menu in which you're able to create, edit and position the elements. It's a dynamically designed page, so your browser is required to appropriately support the JavaScript language. As you can see on the picture below, the window is divided into two well defined areas: The button box, the work area (within which the visual console is going to be drawn) and the options palette (which isn't visible on the picture).

<center>
[[File:Pandora new visual console, tab editor.png|600px]]<br />
''Example of the form tab's data.''
</center>

===== The Button Box =====

The buttons this particular tool is composed of are the following:

* Buttons to create different types of elements, located on the left side named 'Static Graph', 'Percentile Item' (bubble and percentile type), 'Module Graph', 'Simple Value Label', 'Icon' and 'Service'. 

If you click on them, the options palette containing the fields to fill out in order to create an element of this type is going to appear. They can also be deactivated if you're editing or creating an element. If it's active in the moment you're clicking on it, it's going to close the options palette.

* The 'Delete Item' button which is deactivated by default until you select an element, except the background. By clicking on it, it's going to delete the element of this visual console for good and also deletes it from the database.
<br>
{{Warning|Deletions carried out by the 'Delete Item' button '''cannot''' be undone.}}

* The 'Edit Item' button, which is also deactivated by default until you select any element contained in the visual console. By clicking on it, it's going to display the options palette of this element, so you're able to edit its values.

===== The Working Area =====

The working area has the size of 100% of your Pandora Console's width and a height of 500 pixels. As you can see, it's equipped with scroll bars for the purpose of rendering the work of handling big sized visual consoles a little easier. Please keep in mind that the visual console's size is the same as the one of the background image. In the working area, all elements which have been created in the default position of '0,0' (which is the upper left corner) are going to be shown.

===== Advanced Options =====

'''Position'''

By default, the position is '0x0', where the first number is the X and the second one is the Y axis. These values are declared in pixels. Please keep in mind and that the Y axis is inverted within which the highest value is '0', ascending downwards. The X axis is defined classically. It starts in the left corner and increases to the right side.

You're not required to insert an exact position here, unless you're required to have a very precise one. You may locate it by moving through the visual console the same way as with a drawing tool after creating an element.

'''Parent'''

In order to represent a link between elements from the visual console, we've used lines that are drawn between them. These lines are drawn in a specific color, depending on the state of the parent element. Within the control, it's going to display a list of elements contained in this visual console which come into consideration to be the parent elements.

'''Linked Map'''

The element can also be the connection to another visual console to obtain more usability, e.g. you have two visual consoles: One which represents the machines inside a building, managed by you and a second visual console which represents a world map. On this last one, the default setting is to have an element, able to change the state (only on static images) which represents the building you are managing and provides easy access to the other one.

This control provides you with a drop-down list which displays the already created visual console to link it.

'''Label Color'''

You may change the text color (which is 'black' by default) for aesthetic reasons or to improve the label's text visibility if the map's background is very dark. It's was also designed as an interactive control. It's also possible to input a color by using the classical HTML hexadecimal format. You may also invoke a pop up which contains the typical color palette.

<center>
[[File:Pandora new visual console, paleta opciones, label color.png]]<br />
''color palette screen shot in the label color.''
</center>

===== Background =====

It's a special type of element which neither can be created nor destroyed. Only the following values could be edited:

* The background image by using the choice palette.
* The size which is gained by the selected background image. Just like the static image, the '0x0' value is a special value which means that it takes the original proportions of the background's image file.
* It's possible to apply the original size of the background by clicking on the 'Original Size' button.
* Also it's possible to modify height-width ratio of the background image. This can be attained by clicking on the 'Proportional Width' and 'Proportional Height' buttons.

(Pandora FMS versions 5 and above only)
* '''Grid:''' You're able to display a grid, designed move elements aligned to that grid. If this option is deactivated, the elements can be moved freely again.

* '''Auto-Save Button:''' If it's disabled, you're only able to move the items because the creation buttons are disabled.

<center>[[File:visual_console17.png]]</center>
<center>''Grid option in the palette''</center>

<center>[[File:visual_console19.png|600px]]</center>
<center>''An example background image with an activated grid feature.''</center>

(Pandora FMS versions 5 and above only)
* '''Save current Edition:''' You're also able to deactivate the auto-save functionality within the visual console which is activated by default and to force the saving by clicking on the diskette-shaped button. This feature really comes in handy in conjunction with slow connections, especially if you're uncertain the auto save has been carried out appropriately.

<center>[[File:visual_console18.png]]</center>
<center>''This is the option to auto save the current visual map within the palette options.''</center>

<center>
[[File:Pandora new visual console, paleta opciones, background.png]]<br />
''This is an example which displays the choice palette when editing the background.''
</center>

=== The Choice Palette ===

It's displayed if you double click on the item you intend to edit or by clicking on the 'edit' button, contained in the button box. The form of the option palette contains the the below mentioned controls for all elements. Some elements contain additional controls which you're able to look up in their corresponding sections.

==== Label ====

Labels are texts which are displayed on its corresponding element in the visual console.

Since the 5.0.1 version of Pandora FMS, it contains a feature-rich editor with which you're able to augment labels by styles.

<center>
[[File:Label visualmap editor pandora5.png]]
</center>

==== Agent ====

An intelligent control with which you're able to search for an agent of your Pandora FMS installation by its IP or the agent's name.

<center>
[[File:Pandora new visual console, paleta opciones, agent.png]]<br />
''Example of one search within the agent's intelligent control.''
</center>

==== Module ====

This control responds to the control's selection of the agent which automatically inserts the modules the corresponding agent contains.

<center>
[[File:Pandora new visual console, paleta opciones, module.png]]<br />
''Example of the intelligent control module in the moment of automatically introducing the agent's modules.''
</center>

=== Elements to use within a Visual Map ===

==== Static Image ====

This element displays a static image. Depending on the state of the module, agent or map, it's always going to display one image or another. In a current Pandora FMS installation they're available under '/var/www/pandora_console/images/console/icons'. You're also able to upload them by the tool included within the file. The image designations are shown below.

&lt;image_name&gt;_&lt;state&gt;.png where the state could be:

<center>
[[File:Static image, example.png]]<br />
''An Example for the images including name and status.''
</center>


* '''""''' If the agent, module or the visual console has any state at all.
* '''bad:''' If the agent contains some failed module, the module itself fails or the visual console (which provides the link) contains some element in a 'bad' state.
* '''ok:''' If the agent, module or the visual console is in the 'ok' state.
* '''warning:''' If the agent contains any module, the module itself or any element on the visual console is in a 'warning' state.

'''Creating a Static Image'''

In order to create a static image, please click on the 'Static Graph' button. It's the first one on the left side of the button box. It's going to display a palette which contains the options for a new image. The common options could be seen on the chapter's beginning named [http://wiki.pandorafms.com/index.php?title=Pandora:Documentation_en:Data_Presentation#The_Choice_Palette '''The Choice Palette'''], but the ones which are considered exclusive for the static image are mentioned in the section below.

'''Static Image Options'''

* '''Image:''' It provides a drop-down control with which you're able to pick the displayed image. It also provides image preview under its control.

*'''Size:''' Within this control, you're able to input an appropriate size for the image. By default, it comes with the value of '0x0' which means that it's going to take the original image's size as a template.

'''Screen Shots'''

<center>
[[File:Pandora new visual console, paleta opciones, static graph, preview image.png]]<br />
''Palette displaying the image preview which is going to be added to the visual console.''
</center>


<center>
[[File:Pandora new visual console, paleta opciones, static graph.png]]<br />
''A view of the choice palette of an appropriate static image view.''
</center>


'''Tricks'''

* In order to create a floating text, you're only required to create a static image, but without an actual image.

==== Icon ====

This element displays a static image which is unassociated to any module.

<center>
[[File:Items_visual_console.png]]<br />
''An icon in the visual map's editor.''
</center>

In a normal Pandora FMS installation, the images are available under '<pandora_home>/images/console/icons'. You're required to upload any new image by using the 'file manager' tool. As for any other element in the visual console, you may associate a label, an initial position, a size, a parent element and a link to another visual map.

You may perform all of these tasks in the visual map editor as shown below.

<center>
[[File:Editor_visual_map.png]]<br />
''Example of an icon creation.''
</center>

'''Icons linked to other Pages'''

Since the 5.0 version, you may associate a complete URL in order to link it to another web page by using a label field.<br><br> 
'''Example''': In order to link an icon within the visual console to the SNMP console, you're required to create one element of the icon type. This icon is going to contain a label which contains the complete SNMP console's URL as shown below.

 <nowiki>http://</nowiki><pandora_home>/index.php?sec=snmpconsole&sec2=operation/snmpconsole/snmp_view

In the preview mode of the visual console, you may can click on the icon and it's going to redirect you to the SNMP console.

==== The Percentile Item Bar ====

Percentile items allow you to see the module's state in a descriptive way. The items can be of the bubble or percentile (progress bar) type.

<center>
[[File:Pandora new visual console, Percentile bar.png]]<br />
''An example of the percentile bar. This example displays the result of a module which monitors the CPU.''
</center>

'''Percentile Item Options'''

The percentile bar contains much less controls than the rest of the elements, but it has four controls which we're going to explain below.

* '''Width:''' This is the percentile's bar width in pixels.
* '''Max Value:''' This is the maximum value, the represented module can assume. For this reason it's always a good thing to examine the module to monitor just to see what's its maximum value is going to be, e.g. in case of the screen shot, it's the CPU module which moves from the value of '0' to '100'.
* '''Type''': This field allows to configure whether the item type is going to be of the 'bubble' or the 'percentile' type. It's a graphical way of representing this item.

<center>[[File:visual_console21.png]]
''An element of the 'percentile' type.''
<br>
</center>
<br><br>

<center>
[[File:visual_console22.png]]
''An element of the 'bubble' type.''</center>

* '''Value to Show:''' This field allows you to choose between the percentage of accomplishment or the module's last value.

* '''Advanced Options:''' This element has no advanced controls which differ from the basic ones.

<center>
[[File:Pandora new visual console, paleta opciones, percentile bar.png]]<br />
''An example of the choice palette for the percentile bar.''
</center>
<br><br>

==== The Module Graph ====

Just as its name says: A graph which provides the activity information of one agent's module which is going to be displayed within the visual console.

<center>
[[File:Pandora new visual console, module graph.png]]<br />
''This is an example of a module's graph element, within which you're looking at a CPU module's last data from one hour ago graphically.''
</center>
<br><br>

'''The Module Graph's Options'''
It's necessary to define width and height in the graph in order for it to change from being hidden to be shown in the advanced options.

* '''Period:''' The period or time frame that goes until the present time. Please keep in mind that this graph is going to change as time progresses.

* '''Size:''' The width and height of the image the graph is going to be displayed in. It's not only the graph itself, but the graph and the ciphers of all axes.

* '''Advanced Options:''' This element has no advanced controls which differ from the basic ones.

<center>
[[File:Pandora new visual console, paleta opciones, module graph.png]]<br />
''Example which displays the graph's choice palette of an edited module.''
</center>
<br><br>


{{tip|Since the graphs were designed to calculate themselves first and create an image afterwards, creating graphs is '''not''' an instantaneous process. Depending on the architecture on which you have built Pandora FMS, its completion can be either almost instantaneous or take quite a few seconds, within which you're only going to see the element's label on the map without the graph's actual image.}}

==== Simple Value ====

This element only displays a text of the '[label][module value]' type in the visual console. You're only required to define a label (if you want), to select the agent and the module which is going to display the intended last value within the visual console's drawing.

<center>
[[File:Pandora new visual console, simple value.png]]<br />
''This is an example in which a CPU module's simple value is shown.''
</center>
<br><br>

'''Simple Value Options'''

The simple value choice palette doesn't have its own controls.

<center>
[[File:Pandora new visual console, paleta opciones, simple value.png]]<br />
''An example which displays the simple value's choice palette.''
</center>
<br><br>

Since Pandora FMS versions 5.0.1 and above, you're also able to setup a style to the value by using the rich editor within the macro (_VALUE_).

==== Label ====

This feature was designed to create labels without any associated content. The only requirement is to fill out the 'Label' field.

<center>[[File:visual_console27.png]]</center>
<center>''An example of label editing''</center>
<br><br>

==== Group ====

It's a static graph which was designed to display the group's status.

<center>[[File:Group palete.png]]<br>
''Group item edition''</center>

=== Sharing a Visual Console ===

From Pandora FMS versions 4.0.2 and above, it's possible to share a visual console with anyone within the company's network, even if they don't have a valid user account to login to Pandora FMS. You may share the visual console with anyone, just by providing a public URL.

Please access the visual console's main view, click on the sharing tab and on the camera-shaped icon as shown on the picture below in order to do so.

<center>
[[image:Share_visual_console.png|800px]]
</center>

This special URL is of the static type and similar to the one shown below.

 http://192.168.50.2/operation/visual_console/public_console.php?hash=86d1d0e9b6f41c2e3e04c5a6ad37136b&id_layout=3&id_user=admin2

Please feel free to share this particular URL with anyone within your company's network and they're instantly able to access the information published in that visual console. They of course can't access any of the links within the console, just the information contained in it. This is a good way to provide access to specific information under Pandora FMS.



[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]

[[Category: Pandora FMS]]