{{$Class}}
{{$Key}}
{{$Value}}
{{$Filter}}
{{$CauseDepth}}
{{$ImpactDepth}}
{{$ImpactLevel}}
{{$Cypher}}
{{$Limit}}
Layout
Collapse group
Filters


User Guide

Overview

Main screen

The main screen represents a subgraph centered on the queried object(s).

Selected nodes (in bold) are the failed nodes. By default, the selected/failed node(s) is(are) the queried object(s). User can change the selection by clicking on nodes.

See "The Graph - Nodes - node selection" to know more about the node selection.

Here is an example of graph with two selected nodes and a filter on nodes of class ConfigurationGroup.

Example of graph
Top right buttons

Buttons

All this button is at the top right of the screen.

Parameter menu button Will open or close the parameter menu. This menu can also be closed by clicking on the "X" button.

See "Settings" to know more about the parameter menu.

Fit or Center button Will fit/center on the Graph/Selected nodes.

See "Settings - Graph Adjustments" to know more about Graph Adjustment.

Help button Will open this window.

Info dialog screenshot

Info dialog

By default the info dialog will open in the top left of the screen.

The info dialog is opened when you select the "Infos" item from the nodes contextual menu (right-click on a node).

The "Info dialog" display informations about the last node on which you clicked with the right-button of your mouse, even if this node is not a selected/failed node. This dialog is composed of:

  • Title bar of the info dialog A title bar

    Where you'll find the node name, an icone which represents it and two buttons that allows for minifying and closing the "Info dialog" box.

  • Content of the info dialog

    And the content

    Gives informations detailed about the node.

If the "Info dialog" box is already opened, selecting "Infos" item on another node will replace the content with informations about the new node instead of openning a new dialog box.

By clicking on the minified button the dialog will minimize in the bottom left of the window. Then the minified button is replace with a restore button.

See "Graph - Nodes - Node context menu" to know more about the node context menu.

Legend of the graph

Legend

The legend is in the right bottom corner of the screen.

It show the meaning of nodes colors and edges thickness.

See "Graph" to know more about node and edge.

The Graph

Nodes

Node selection

To mark a node as failed, you must click on it. Hold the "Shift" or the "Ctrl" button if you want to mark several nodes simultaneously.

Node color

The color of a node depends on its position related to the selected nodes:

  • If it is after a selected/failed node, then it represents a potentially impacted object.

  • If it is before a selected/failed node then it represents a potential cause of the failure.

  • If it is not an impacted object nor a cause of the failure, its status is unknown.

The colors of each object are:

  • Possible causes of
    a single node
    several nodes
  • Impacts
    0%
    1 - 50%
    51 - 99%
    100%

    Impacts is for impacted object.

    The impacts is estimated on the preceding edge(s) criticity and the preceding node(s) impacts. It may also depend on the node redundancy and collaboration nodes.

    If the node has redundancy, the MIN impact of all redundant node is taken.

    If the node has collaboration nodes, the SUM of all the collaboration nodes is taken.

    And, of course, all of the node impact are calculated with redundancy and collaboration nodes and other node failure cause to take the MAX of all of them.

  • Unknown state
    Node

A selected node is a failed node. The impacts of a failed node is 100%.

Node drag-n-drop

You can move nodes by drag-n-drop.

  • Dragging a selected node will move all the selected nodes together.

  • Dragging an unselect node will move this node only.

You can move selected nodes by drag-n-drop to place them at a much pleasant location for you.

You also can move a single not selected node by drag-n-drop.

Node context menu

Node context menu

By right-clicking on a node you will open a context menu that allow you to:

  • Infos

    This option will open a dialog who will show you informations about the node.

    For more informations about the info dialog see the "Main screen - Info dialog" section.

  • Filter node with this class

    This option will activate the filter settings and added this node class's to the liste of class's to filter.

Edges

Edge color

The edge color depend on the source node color for simple edge.

For edge with filtered node the color is depend on the lower impacts of the nodes it replace.

Edge thickness

Edges have two different thickness. One is for simple edges and the other is for edge that go through filtered nodes.

Edge
an edge
an edge with filtered nodes

You will also find this informations in the legend at the bottom right of the screen.

See section "Settings - Filter options" to know more about how to filter nodes.

Background

Background dragn-n-drop

You can do a drag-n-drop on the background to move the entire graph.

Background context menu

Context menu on blank

By right-clicking on the background you will open a context menu taht allow you to:

  • Select query nodes

    This option will select the default selected node(s).

Settings

The settings concern the parameter menu.

It open just in bottom of the parameter menu button.

This menu allows for setting layout, nodes filter and behavior of the "Fit or Center" button.

Layout section

Layout and Filter

This section allows for choosing layout, grouping nodes or filtering nodes.

It is composed by:

  • A list of layout

    Layout list item These list present you the layout algorithm, ordered by their execution speed. The general form is "Layout_name |(Speed|[G])", where "Layout_name" is the name of the layout, "Speed" is the speed of the rendering of the layout and the flag "G" indicates whether or not the layout support group.

  • Two directions

    Layout direction options Some layout will allow you to chose the direction of the edges. This options will calculate a renderer for a layout from Top to Bottom (TB) or from Left to Right (LR).

  • Three possible choice for grouped layout

    Layout group options

    When the chosen layout supports nodes grouping (i.e. layout with flag "G") then the group section allows to chose between the following options:

    • NoGroup, do not group nodes.
    • GroupByCause, group nodes which belong to the same class and which are potential cause of the same nodes.
    • GroupByImpact, group nodes which belong to the same class and which are potentially impacted by the same nodes.
  • Filtering option

    This section is composed by two subsection:

    • Filter activation section Radio buttons to enable or disable nodes filtering.

    • List of classes for filter

      A set of checkboxes (one per node class), unchecking a given class will filter out all the nodes of this class (i.e. these nodes will be removed from the graph).

  • Apply changes

    Apply button for layout settings A button to refresh the graph with new settings.

Graph adjustment section

Graph Adjustments

This section allows for setting-up your graph adjustments preferences.

This section is composed of:

  • Fit or Center choice

    Fit or Center choice Chose "Fit" if you want to Fit (i.e. center and zoom or unzoom so that the target fills the screen) or "Center" if you want to Center only.

  • Target choice

    to Graph/Selected nodes choice Chose "to Graph" if you want to Fit or Center to the full graph or "to Selected nodes" to Fit or Center to selected nodes only.

  • Apply button for fit or center settings A button to fit or center to target according to the new adjustement's preferences.

Export graphml button

Export

This button allow you to export the graphml (i.e. XML format).

Impacts
0%
1 - 50%
51 - 99%
100%
Possible causes of
a single node
several nodes
Unknown state
Node
Node Shape
Single node
Expanded group of nodes
Collapsed group of nodes
Edge
an edge
an edge with filtered nodes
Class dependencies model

No sub-graph selected