Appboard/old/widgets/topology 2.2 - Revision history

imported>Jason.nicholls at 11:46, 17 July 2014

2014-07-17T11:46:44Z

← Older revision		Revision as of 11:46, 17 July 2014
Line 1:		Line 1:
	{{Note\|This page documents the deprecated Topology Widget that existed in AppBoard versions prior to 2.3. For documentation on the current Topology Widget, see [[~~Topology_Widget~~\|Topology Widget]].}}		{{DISPLAYTITLE:Topology Widget 2.2}}
			[[Category:AppBoard old]]
			{{Note\|This page documents the deprecated Topology Widget that existed in AppBoard versions prior to 2.3. For documentation on the current Topology Widget, see [[appboard/old/widgets/topology\|Topology Widget]].}}

imported>Jason.nicholls: moved Topology Widget 2.2 to appboard/old/widgets/topology 2.2

2014-07-17T11:46:06Z

moved Topology Widget 2.2 to appboard/old/widgets/topology 2.2

← Older revision	Revision as of 11:46, 17 July 2014
(No difference)

imported>Jason.nicholls: /* How To Create a Topology Widget */

2014-07-17T07:05:50Z

How To Create a Topology Widget

← Older revision		Revision as of 07:05, 17 July 2014
Line 11:		Line 11:
	== How To Create a Topology Widget ==		== How To Create a Topology Widget ==

	For instructions on creating a Widget, see the general instructions in [[~~Widgets~~#Adding_Widgets\|Adding Widgets]]. The <b>Topology</b> Widget type is located under the <b>Diagrammer</b> category on the Widget selection screen.		For instructions on creating a Widget, see the general instructions in [[appboard/old/widgets#Adding_Widgets\|Adding Widgets]]. The <b>Topology</b> Widget type is located under the <b>Diagrammer</b> category on the Widget selection screen.


	== How To Configure an Area Chart Widget ==		== How To Configure an Area Chart Widget ==

imported>Jason.nicholls: /* Additional Configuration Steps */

2014-07-17T04:21:21Z

Additional Configuration Steps

← Older revision		Revision as of 04:21, 17 July 2014
Line 45:		Line 45:

	=== Additional Configuration Steps ===		=== Additional Configuration Steps ===
	* Provide additional configuration, if needed, on the <b>Options</b> tab. For details on the available Options, see [[~~Options~~\|Options]].		* Provide additional configuration, if needed, on the <b>Options</b> tab. For details on the available Options, see [[appboard/old/options\|Options]].


	* Enter the following information on the <b>Actions</b> tab:		* Enter the following information on the <b>Actions</b> tab:
	** Click <b>Add Event Action</b> to configure one or more [[~~Actions~~\|Actions]] to be invoked when a user clicks on the Topology Widget. The action will apply to the current data record being displayed.		** Click <b>Add Event Action</b> to configure one or more [[appboard/old/actions\|Actions]] to be invoked when a user clicks on the Topology Widget. The action will apply to the current data record being displayed.


	== Sample Data ==		== Sample Data ==

imported>Jason.nicholls: /* Select a Data Collection */

2014-07-17T03:59:59Z

Select a Data Collection

← Older revision		Revision as of 03:59, 17 July 2014
Line 23:		Line 23:
	Select a '''Data Collection''' that contains the information you would like to use for this Widget.		Select a '''Data Collection''' that contains the information you would like to use for this Widget.
	* Click the "Data Collection" pulldown, then select from the list of available Data Collections.		* Click the "Data Collection" pulldown, then select from the list of available Data Collections.
	* If there are no Data Collections available in the pulldown, then click here for instructions on how to bring in some [[Sample_Chart_Data\|Sample Chart Data]], or refer to [[~~Data_Collections~~\|Add/Edit/Remove a Data Collection]].		* If there are no Data Collections available in the pulldown, then click here for instructions on how to bring in some [[Sample_Chart_Data\|Sample Chart Data]], or refer to [[appboard/old/data_collections\|Add/Edit/Remove a Data Collection]].
	See the Sample Data section below for instructions on using sample data to create a Topology Widget		See the Sample Data section below for instructions on using sample data to create a Topology Widget


	The Topology Widget uses a field called "children" to determine how data items are related to one another. To use the Widget, you must first create a Data Source with an Association. On the "Associate" tab of the Data Source editor, create a field called "children" which associates one entity to another. For example, you could associate the Host_Name field in a datacenter table with the Host_Name field in a server details table. Then have the Topology Widget use a Data Collection which uses this Data Source. The Widget will use the "children" association to draw the topology.		The Topology Widget uses a field called "children" to determine how data items are related to one another. To use the Widget, you must first create a Data Source with an Association. On the "Associate" tab of the Data Source editor, create a field called "children" which associates one entity to another. For example, you could associate the Host_Name field in a datacenter table with the Host_Name field in a server details table. Then have the Topology Widget use a Data Collection which uses this Data Source. The Widget will use the "children" association to draw the topology.


	=== Configuring the Label Field ===		=== Configuring the Label Field ===

imported>Mike.berman: created page

2013-02-19T21:36:51Z

created page

New page

{{Note|This page documents the deprecated Topology Widget that existed in AppBoard versions prior to 2.3. For documentation on the current Topology Widget, see [[Topology_Widget|Topology Widget]].}}

A Topology Widget is a diagram that displays the visual layout of devices that are connected to one another, typically on a computer network.

[[Image:TopologySample.jpg|thumb|center|500px|Topology Widget Sample]]

== How To Create a Topology Widget ==

For instructions on creating a Widget, see the general instructions in [[Widgets#Adding_Widgets|Adding Widgets]]. The Topology Widget type is located under the Diagrammer category on the Widget selection screen.

== How To Configure an Area Chart Widget ==

Follow the instructions above to create the basic "Topology" Widget, and then perform the following steps to configure an Area Chart Widget:

=== Select a Data Collection ===

Select a '''Data Collection''' that contains the information you would like to use for this Widget.
* Click the "Data Collection" pulldown, then select from the list of available Data Collections.
* If there are no Data Collections available in the pulldown, then click here for instructions on how to bring in some [[Sample_Chart_Data|Sample Chart Data]], or refer to [[Data_Collections|Add/Edit/Remove a Data Collection]].
See the Sample Data section below for instructions on using sample data to create a Topology Widget

The Topology Widget uses a field called "children" to determine how data items are related to one another. To use the Widget, you must first create a Data Source with an Association. On the "Associate" tab of the Data Source editor, create a field called "children" which associates one entity to another. For example, you could associate the Host_Name field in a datacenter table with the Host_Name field in a server details table. Then have the Topology Widget use a Data Collection which uses this Data Source. The Widget will use the "children" association to draw the topology.

=== Configuring the Label Field ===

Select the desired '''Label Field''' to use for naming the items in the topology display.

=== Status Rules - Color Filter ===

[Optional] Click Add to create a set of Color Filter rules which will determine the coloration of the icons for each node in the Topology diagram, based on the attributes of that node.

=== Icon Rules - Icon Filter ===

[Optional] Click Add to create a set of Icon Filter rules which will determine the icon to display for each node in the Topology diagram, based on the attributes of that node.

=== Additional Configuration Steps ===
* Provide additional configuration, if needed, on the Options tab. For details on the available Options, see [[Options|Options]].

* Enter the following information on the Actions tab:
** Click Add Event Action to configure one or more [[Actions|Actions]] to be invoked when a user clicks on the Topology Widget. The action will apply to the current data record being displayed.

== Sample Data ==

Perform the following steps to create a Topology Widget using sample data provided with Appboard:

=== Create a Data Source ===
# Log in to AppBoard Builder as an administrator.
# In the Builder Modes panel, select Data Sources.
# Click the "Add" button in the bottom toolbar. The "Create New Data Source" dialog is displayed.
# Type in the name "Sample.TreeMap".
# Select the "File" category for the adapter type, then choose "CSV File".
# Click the "Add Data Source" button in the bottom toolbar.
# The "CSV File" Data Source Wizard is displayed.

=== Configure the Data Source ===
# For the File Path, enter <tt>${application.home}/data/pkg/appboard/tutorial/TreeMapData.csv</tt>.
# Click "Next" in the bottom toolbar.
# On the "Explore" step, click "Next".
# On the "Associate" step, click "Add Association".
## For "Add Field", enter "children". This is the name the Tree Map Widget uses to determine associations.
## Use the "Select Entity" drop-downs to set an association of "sample.TreeMap.TreeMapData.Network_ID" = "sample.TreeMap.TreeMapData.Parent_ID"
# Click "Finish".

=== Configure the Data Collection ===
# In the Builder Modes panel, select Data Collections.
# Click "Add".
# Name the Data Collection "sample.Topology"
# For the Data Source, select "sample.TreeMap.TreeMapData"
# Click Next to go to the "Client Side Filter" panel
# Add a Rule of type "Simple Property Comparison"
# Enter the property "Network_ID" "=" "2"
# Click "Finish".

=== Configure the Widget ===
# For the Data Collection, select "sample.Topology"
# For the Label Field, select "Location"
# For the Area Field, select "Outages"
# Add a Color Filter called "Topology Colors"
## Select "Add Color" six times to add six rows
## For the first rule, select the red color and set the rule to be "Color" "=" "Red"
## Repeat the same step for the colors green, gray, blue, white, and brown
## Click "X" to close the Color Filter editor
# Add an Icon Filter called "Topology Icons". Configure the icons such as illustrated in the following diagram:

[[Image:TopologyIconFilter.png|thumb|center|700px|Sample Topology Icon Filter Rules]]

The completed Widget should provide a display similar to the following:

[[Image:TopologySample.png|thumb|center|700px|Topology Widget Using Sample Data]]

{{Tip|Note that in the above example, the Topology Widget is being used to show not only the devices on a regional network, but also whether any critical or non-critical alarms have been received for these devices}}