Appboard/2.4/builder/widgets/topology: Difference between revisions

imported>David.moore
imported>Johnfraleigh
 
(6 intermediate revisions by 3 users not shown)
Line 46: Line 46:




# '''Relationship Model''' – Choose the Relationship Model that describes the relationships and appearance configuration of the underlying data.
* '''Relationship Model''' – Choose the Relationship Model that describes the relationships and appearance configuration of the underlying data.
# '''Default Layout''' – Choose the layout you would like the Topology Widget to initially use for displaying the relationships.
* '''Default Layout''' – Choose the layout you would like the Topology Widget to initially use for displaying the relationships.
# '''Link Arrows''' – Choose whether to have directional, bidirectional, or no link arrows for the lines connecting the nodes.
* '''Link Arrows''' – Choose whether to have directional, bidirectional, or no link arrows for the lines connecting the nodes.
# '''Max Number of Hops''' – Increasing this number will display more topology layers on the screen at a time, without requiring that the user drill down to the deeper layers.  This is an important performance setting that tells the Widget how far to traverse the relationships.  Limiting this number keeps cyclical topologies from locking up the relationship traversal code.
* '''Max Number of Hops''' – Increasing this number will display more topology layers on the screen at a time, without requiring that the user drill down to the deeper layers.  This is an important performance setting that tells the Widget how far to traverse the relationships.  Limiting this number keeps cyclical topologies from locking up the relationship traversal code.
# '''Node Renderer Type''' – Choose between two rendering styles of the topology nodes:
* '''Node Renderer Type''' – Choose between two rendering styles of the topology nodes:
#* Background with Icon - Displays the icon inside of a white box.
** Background with Icon - Displays the icon inside of a white box.
#* Icon Only - Displays only the icon for each node, floating on the Widget's background with no box.
** Icon Only - Displays only the icon for each node, floating on the Widget's background with no box.
# '''Auto Node Drill Down''' – This turns on automatic drill down navigation on nodes.  Clicking the drill down icon on a node will focus on that node and show its children and/or parents.  This produces an effect of navigating deeper into a topology.  Setting the Max Number of Hops to a low number can help the performance and experience of this setting.
* '''Tint Node''' – This turns on tinting of the node using the status color.
# '''Multiple Links''' – You can choose to collapse or show multiple links between nodes.
* '''Auto Node Drill Down''' – This turns on automatic drill down navigation on nodes.  Clicking the drill down icon on a node will focus on that node and show its children and/or parents.  This produces an effect of navigating deeper into a topology.  Setting the Max Number of Hops to a low number can help the performance and experience of this setting.
# '''Polling Interval (seconds)''' – Check the box to enable polling for changes in the relationship model.  This is separate from the polling setting on the Data Collection that determines how frequently the underlying data is updated.
* '''Multiple Links''' – You can choose to collapse or show multiple links between nodes.
* '''Polling Interval (seconds)''' – Check the box to enable polling for changes in the relationship model.  This is separate from the polling setting on the Data Collection that determines how frequently the underlying data is updated.




Each Topology Widget has a special toolbar that the end user can toggle by clicking the large wrench icon.  This toolbar allows the user to “fit the topology” within the view, zoom to 100%, refresh the data, and change the layout of the data.
Each Topology Widget has a special toolbar that the end user can toggle by clicking the large wrench icon.  This toolbar allows the user to “fit the topology” within the view, zoom to 100%, refresh the data, and change the layout of the data.


== Topology Widget Usage Examples ==


== Topology Widget Usage Example #1 ==
For examples of using the Topology Widget, please see the [[appboard/2.4/builder/widgets/topology/basic_example|Basic Example]] and the [[appboard/2.4/builder/widgets/topology/selfref_example|Self-Referential Example]].
 
The following is a step by step “hands on” example of using the Topology Widget:
 
 
=== Create a new Data Source ===
 
# Click the '''Data Sources''' toolbar option on the left.
# Click '''Add''' on the bottom right of the Administration Page.
# Give the Data Source the name of “Showcase” and choose the adapter type of '''File''' and then select '''CSV Directory''' .
# Click the '''Add Data Source''' button and you will be presented with a new Wizard. 
# On the '''Connect''' wizard page use ''${application.home}/data/showcase/CSV'' as the directory value and leave all the other configuration options alone.
# Click '''Next''' and you will be shown all the CSV Tables that were found in that directory.  Use the following screenshot to set the Primary Key for each of the five tables shown in the following figure:  [[Image:topologyprimarykey.jpg|thumb|center|700px|Primary Key Settings]]
# The table '''application_assets''' needs a Multi Primary Key.  Click '''Edit''' and select '''AppID''' and '''AssetID'''.
# The table '''services_applications''' also needs a Multi Primary Key.  Click '''Edit''' and select '''ServiceID''' and '''AppID'''.
# On the Associate screen, click '''Add Association''' four times and configure the selections as shown in the figure below:  [[Image:topology_associations.jpg|thumb|center|700px|Associations]]
 
 
=== Create a new Relationship Model ===
 
# Navigate to the '''Data Collections''' page and switch the '''Collection Type''' to the '''Relationship''' mode by clicking on the toggle switch.
# Click the '''Add''' button to launch the relationship model editor.
# For the '''Model Name''', enter '''Service Model'''.
# First we need to add the “root” node type for our model.  Click the '''Add Source''' button and pick '''showcase.services'''.
# Next we want to add relationships to this root node.  Click the '''green “+” button''' on the '''services''' badge.
# For '''Relationship Target''' select '''services_applications.applications_detail'''.  For '''Relationship Type''' select '''Child'''.  We are telling the relationship model editor that we want to get all the applications that are children of the service by following the association path through the join table.  Click '''Finish'''.
# Now we tell the model editor about the relationship to assets.  Click the '''green “+”''' on the '''applications_detail''' badge.
# For '''Relationship Target''' select '''applications_assets.assets'''.  For '''Relationship Type''' select '''Child'''.  We want to see the assets connected to the applications by following the association through the application_assets join table.  Click '''Finish'''.[[Image:Showcase_RelationModel.jpg|thumb|center|700px|Associations]]
# To describe the data with appearance rules, click the '''yellow “/” button''' on the '''Services''' Badge.
# Click the '''Name''' token in the list to make the label rule show the Service Name value as the label of the nodes rendered for this data type.  In this sample data we don’t have status for services so we can skip to the '''Icon''' rule tab.
# Add an Icon Rule called '''Service Icon''', click to add an Icon, and select '''Chevron Short''' from the library under '''Available Icons'''.  In the two pull-downs, select '''Type''' and '''is not null'''.  This creates a simple rule that as long as the Type of a service is not empty, we will show a Chevron Icon.
# Click '''Close''' to close the Icon Rule Editor and select the Icon Rule called '''Service Icon''' from the drop-down list, if it is not already selected.
# Click '''Close''' to return to the '''Relation Model Editor'''.
# Click the '''yellow “/”''' on the '''Applications_detail''' badge.
# Select '''ApplicationName''' for the label.
# Under the '''Color''' tab, add a Color Filter rule called '''Criticality''', and create four '''Color''' rules selecting a different color for each.  Use '''Criticality''', '''=''', and enter the numbers 1-4 in the '''Value''' boxes (1 for the first, 2 for second, etc.).  Click '''Close'''.
# Skip the '''Status Shape''' rules.
# For the '''Icon''' section, add an Icon rule called '''Application Icon''', using the '''Application1''' Icon from the library and selecting '''AppID''' and '''is not null''' for the rule.
# Click '''Close''' to close the Icon Rule Editor and select the Icon Rule called '''Application Icon''' from the drop-down list, if it is not already selected.
# Click '''Close''' to return to the '''Relation Model Editor'''.
# Click the '''yellow “/”''' on the '''Assets''' badge.
# Use '''Name''' for the label.
# Add a Color Filter called '''Asset Colors''', and click to add three '''Color''' rules selecting a different color for each.  Use '''State''', '''=''', and enter the numbers 1-3 in the '''Value''' boxes.
# Click '''Close''' to close the Color Filter Rule Editor and select the Color Filter Rule called '''Asset Colors''' from the drop-down list, if it is not already selected.
# Go to the '''Icon''' section, add an Icon rule called '''Asset Icon''',and select '''Rackmount01''' as the Icon with '''Type''' and '''is not null''' as the rule.
# Click '''Close''' to close the Icon Rule Editor and select the Icon Rule called '''Asset Icon''' from the drop-down list, if it is not already selected.
# Close the dialog and click '''Finish''' in the Relationship Model Editor.
 
 
=== Create a new Topology Widget ===
 
# Click the '''Add Stack''' button in the left panel.  Add a Stack called '''My Topology'''.
# Click the '''Add Widget''' button in the left panel.
# For '''Widget Type''' select the '''Topology Widget''' from the '''Diagrams''' category.
# Select the Data Collection '''showcase.services'''.
# Enter the Widget Name "Service Topology Example".
# Click '''Next'''.
# For the  '''Relationship Model''', select "Service Model".
# For '''Default Layout''' select "Bi-Hierarchical".
# Enable '''Auto Node Drill Down'''.  Keep all remaining default options.
# Click '''Next''', and '''Finish'''.  View the completed Topology Widget in the Builder.
 
 
Observe that there are many services displayed, producing a diluted Topology.  The final step is to filter the Data Collection to only show services that have children, which would provide meaningful information in a topology view.
 
 
=== Filter the Data in the Topology Widget ===
 
# Navigate to the '''Data Collections''' page and leave the '''Collection Type''' switch on the default '''Flat Collection''' setting.
# Click the '''Add''' button to launch the '''Data Collections Wizard'''.
# For the '''Data Collection Name''', enter "Services With Children".
# For the '''Data Source''', select "Showcase.services".
# Click the '''Configure Client Side''' tab to go to the '''Client Side Filter''' configuration tab.
# Click '''Add Rule''' to add a Rule of type "Simple Property Comparison".
# For the rule, enter Property '''services_applications[].AppID''' '''is not null'''.
# Click '''Ok'''.
# Go to the '''Widgets Administration''' panel and edit the '''Service Topology Example''' Widget.
# Change the Data Collection to "Service With Children" (the new filtered data set of services).
# Click '''Close'''.  View the completed Topology Widget in the Builder.  The finished product should look similar to the image at the beginning of this page.
# Drill down into some of the nodes by clicking the arrow image in the upper-right section of the node icon.
 
== Topology Widget Usage Example #2:  Self-Referential Topology ==
 
 
=== Create a new Data Source ===
 
# Click the '''Data Sources''' toolbar option on the left.
# Click the '''Add''' button.
# Give the Data Source the name "TopologyExample" and choose the adapter type of '''File''' and then select '''CSV Directory''' .
# Click the '''Add Data Source''' button and you will be presented with a new Wizard.
# On the '''Connect''' wizard page use ''${application.home}/data/TopologyExample'' as the directory value and leave all the other configuration options alone.
# Click '''Next''' and you will be shown all the CSV Tables that were found in that directory.
# '''[IMPORTANT]''' For ''NetworkNodes'', click the '''Edit''' button and select ''UID'' as the primary key.  Click the '''OK''' button.
# '''[IMPORTANT]''' For ''NetworkTopology'', click the '''Edit''' button and select both ''toID'' and ''fromID'' as the primary keys.  Click the '''OK''' button.
# Click the '''Next''' button and you will be shown the '''Associate''' page.
# Click the '''Add Association''' button in the bottom left of the screen.
# For the association that appears, in the left dropdown list, select ''TopologyExample.NetworkTopology.toID''.  Leave the middle dropdown list as ''EQUALS''.  In the right dropdown list, select ''TopologyExample.NetworkNodes.UID''.
# For the name, if it is not entered automatically, enter "NetworkNodes".  Set the '''Type''' as ''One to One''.  Leave '''Publish''' as ''Always''.
# Click '''Add Association''' to add another association.
# In the left dropdown list, select ''TopologyExample.NetworkNodes.UID''.  Leave the middle dropdown as ''EQUALS''.  In the right dropdown list, select ''TopologyExample.NetworkTopology.fromID''.
# For the name, if it is not entered automatically, enter "NetworkTopology".  Set the '''Type''' as ''One to Many'' and leave '''Publish''' as ''Always''.  Click '''Finish''' to close the Wizard.[[Image:SRTopology_DSAssociate.PNG|thumb|center|700px|Associations]]
 
=== Create a new Relationship Model ===
 
# Navigate to the '''Data Collections''' page and switch the '''Collection Type''' to the '''Relationship''' mode by clicking on the toggle switch.
# Click the '''Add''' button to launch the relationship model editor.
# For the '''Model Name''', enter "TopologyExampleModel".
# First we need to add the “root” node type for our model.  Click the '''Add Source''' button and pick ''TopologyExample.NetworkNodes''
# Next we want to add relationships to this root node.  Click the '''green “+” button'''.  In the dialog that appears, for the '''Relationship Target''' dropdown list, select ''NetworkTopology.NetworkNodes''.  Leave the '''Relationship Type''' as ''Child''.  Click '''Finish'''.[[Image:SRTopology_RME.PNG|thumb|center|700px|Relation Model Editor]]
# To describe the data with appearance rules, click the '''yellow “/” button'''.
# In the window that appears, on the '''Label''' page, select the ''Name'' token to use it in the '''Label'''.
# Click the '''Color''' tab and click the '''Add''' button to add a '''Color Filter'''.
# In the window that appears, change the name to "Status Rule".
# Click '''Add Color''.  Change the color to ''red'' and set the '''Property''' to ''Status''.
# Leave the '''Comparator''' as ''='' and in '''Value''', enter "0".
# Click the '''Add Color''' button three more times.  The '''Property''' and '''Comparator''' dropdown list selections should stay the same for each color and the '''Values''' should increment by one for each color.  If this did not happen, be sure to set '''Property''' to ''Status'', '''Comparator''' to ''='', and '''Value''' to "1", "2", and "3". For these items, set the colors to ''orange'', ''yellow'', and ''green'' (''orange'' for "1", ''yellow'' for "2", ''green'' for "3").  Click '''Close'''.
# If the '''Color Filter''' dropdown list does not say ''Status Rule'', click the list and select ''Status Rule''.
# Click the '''Icon''' tab and click the '''Add''' button.
# In the window that appears, set the name to "Icon Rule" and click '''Add'''.
# Click the '''Available Icons''' button and select the icon for ''Server 1''.  Click '''OK'''.
# Click the dropdown list under '''Property''' and select ''Type''.
# Leave '''Comparator''' as ''='' and for '''Value''' enter "Server".
# Click '''Add''' two more times.
# For the first item, set the icon to ''Router'' and in '''Value''', enter "Router".
# For the second item, set the icon to ''Monitor'' and in '''Value''', enter "Workstation".  Click '''Close'''.
# If the Icon Filter dropdown list does not say ''Icon Rule'', click the list and select ''Icon Rule''.
# Click '''Close''' to exit the '''Configure Appearance''' window and then click '''Close''' again to exit the '''Relation Model Editor'''.
 
=== Creating a Root-level Data Collection ===
 
# On the '''Data Collections''' page, switch the '''Collection Type''' to the '''Flat Collection''' mode by clicking on the toggle switch.
# Click '''Add''' create a new data collection.
# For the '''Data Collection Name''', enter "TopologyExampleRouters" and in the '''Data Source''' dropdown list, select ''TopologyExample.NetworkNodes''.
# Check the '''Filter''' option and click '''Add Rule'''.
# In the '''Property''' dropdown list, select ''Type''.
# Leave '''Comparator''' as ''='' and set '''Value''' to "Router".
# Click '''OK'''.
 
=== Creating a Stack ===
 
# Navigate to the '''Stacks & Boards''' page.
# Click '''Add Stack''', enter "TopologyExample" for the title, and click '''Add Stack'''.
 
=== Creating the Topology Widget ===
 
# Navigate to the '''Widgets''' page and click the '''Add''' button to open the '''Widget Wizard'''.
# Click the '''Widget Type''' button and select ''Diagrams'' and choose ''Topology''.  Click '''Use Selected'''.
# Click the '''Data Collection''' dropdown list and select ''TopologyExampleRouters''.
# Enter "TopologyExample" for the '''Widget Name'''.  Click '''Next'''.
# Click the '''Relationship Model''' dropdown list and select ''TopologyExampleModel''.
# Set the '''Default Layout''' to ''Hierarchical Cyclic'' if it is not already selected and set '''Auto Node Drill Down''' to ''Enabled''.
# '''[Optional]''' Click the '''Link Arrows''' dropdown list and choose ''Directional'', and increase the '''Max Number of Hops''' to see different levels of the hierarchy.
# Click '''Next''' and then click '''Finish'''.
# Select ''TopologyExample'' in the list of widgets and click the '''Board''' column to change the board to ''TopologyExample''.
 
=== Viewing the Topology Widget ===
 
# Navigate to the '''Builder''' page and click on the tab for the stack called '''TopologyExample'''.
# Use the mouse to drag (click and drag) and zoom in or out (mouse wheel up or down) on the widget as needed.
# Different nodes in the diagram can be clicked to perform a drill down and see connections at different levels in the hierarchy.

Latest revision as of 18:57, 5 May 2014


Sample Topology Widget


The new Topology Widget was formally introduced to AppBoard in the 2.3 version release. Its purpose was to allow data with connectivity information to be rendered automatically as a graph of nodes. The data structure for the topology has an open architecture that allows many different methods of representing a topology in data. For instance, you can render a topology using a connectivity table that is associated to other tables, or a simple table that has a 1 to 1 reference to its parent data.


Overview

Before beginning to you use the Topology Widget, it is important to understand that there are three steps to using the Widget effectively:

  1. Associate the Data Sources on the Server - The data that is going to be represented in a topology needs to be associated on the server first. If you have resources that are related to a join table which is related to other resources, for example, you must create associations that walk that relationship.
  2. Create a Relationship Model that Defines the Relationships on the Client - A relationship model must be created on the client that describes the relationships that were created on the first step. This includes describing if the associations are parental or child like in relationship, how the data should be depicted when rendered (colors, icons, labels), and what portions of the relationships should be rendered. For instance, it is possible to have a relationship such as 'router associated with server', which is associated with an event, and then only show the router and the events.
  3. Create and Place a Topology Widget on a Board - When creating an instance of the Topology Widget on a Board, it is important to remember that the Widget will require seed data before it can render. Typically this would be a Data Collection that contains one to a few root nodes. The Relational Model that is attached to the Topology Widget will then interrogate the root nodes and follow the model looking for data that is connected. The beauty of it having a seed Data Collection is that AppBoard Actions can fire Data Collection filtering, causing the Topology to re-render with a new root node or set of nodes.
Template-tip.png
It may feel like you have to describe the relationships within your data twice, but there are reasons behind this process. While data may be related with each other on the server, there may be portions of your data relations that you do not want to show within the Widget itself, but need in order to access the next “hop” of data. For instance, if you have events hanging off of servers that are within clouds in your data model, but only want to show the events within a cloud of servers, you can choose to not include the servers in the client-side relational model and it will render clouds with events connected to them. Also, the relational model stores the visual aspects of the data so you do not have to describe the appearances over and over again if you have multiple topology views of the same data.


Using the Relational Model Editor

This section makes an assumption that the reader is already familiar with associating data on the server, as referred to in the first step. The second step in using a Topology Widget, however, is a new administration Action that has been added to the 2.3 version of AppBoard.

To create a new Relational Model, perform the following steps:

  1. Click Data Collections in the left panel.
  2. Click the Data Collections Type switch. This places the Data Collection admin page into the Relationship mode. Relationships are basically Data Collections that are relational in nature, such as hierarchies.
  3. Click the Add button to open a new dialog that allows you to create a new Relational Model.
  4. Give the model a name that describes what you will be displaying in the Topology Widget.
  5. Click the Add Source button to add a data source that you would like to render as root nodes in your topology display. This adds a data type node to the graphical view of your Relational Model. The top label is the data source and the bottom label is the Column or MetaClass that will be rendered. The green “+” button is used to add a relationship to the MetaClass. The yellow “/” button is used to add visual rules to the MetaClass, so that when it is rendered in a topology it knows what icon, label, and colors to use.
  6. Continue to add more sources and relationships to build a complex data model with multiple associations. Note that the Topology Widget can render relationships from any place in the relational model. You do not have to start with the data type on the farthest left.
  7. To configure the appearance of these data types, click the yellow “/” button.
  8. The first step of the Configure Appearance dialog allows you to setup a label rule for the data that gets rendered. Click on 1 or more tokens in the list below to have the client fill in values from the data object into the label. You can add prefixes and suffixes to these tokens.
  9. The next step Color lets you choose a default color and add rules to determine how to render the background of the node label.
  10. Next, Status Shape rules give the node renderers details about what status icon to display as additional visual feedback. This is helpful for displaying status to those who may have trouble distinguishing colors or are fully color blind.
  11. The final step, Icon, allows you to configure a similar set of rules to the previous two sections for what icons to display on the topology.


Creating a Topology Widget Instance

The configuration dialog for the Topology Widget has the following settings:


Topology Widget Settings


  • Relationship Model – Choose the Relationship Model that describes the relationships and appearance configuration of the underlying data.
  • Default Layout – Choose the layout you would like the Topology Widget to initially use for displaying the relationships.
  • Link Arrows – Choose whether to have directional, bidirectional, or no link arrows for the lines connecting the nodes.
  • Max Number of Hops – Increasing this number will display more topology layers on the screen at a time, without requiring that the user drill down to the deeper layers. This is an important performance setting that tells the Widget how far to traverse the relationships. Limiting this number keeps cyclical topologies from locking up the relationship traversal code.
  • Node Renderer Type – Choose between two rendering styles of the topology nodes:
    • Background with Icon - Displays the icon inside of a white box.
    • Icon Only - Displays only the icon for each node, floating on the Widget's background with no box.
  • Tint Node – This turns on tinting of the node using the status color.
  • Auto Node Drill Down – This turns on automatic drill down navigation on nodes. Clicking the drill down icon on a node will focus on that node and show its children and/or parents. This produces an effect of navigating deeper into a topology. Setting the Max Number of Hops to a low number can help the performance and experience of this setting.
  • Multiple Links – You can choose to collapse or show multiple links between nodes.
  • Polling Interval (seconds) – Check the box to enable polling for changes in the relationship model. This is separate from the polling setting on the Data Collection that determines how frequently the underlying data is updated.


Each Topology Widget has a special toolbar that the end user can toggle by clicking the large wrench icon. This toolbar allows the user to “fit the topology” within the view, zoom to 100%, refresh the data, and change the layout of the data.

Topology Widget Usage Examples

For examples of using the Topology Widget, please see the Basic Example and the Self-Referential Example.

Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/2.4/builder/widgets/topology&oldid=3682"