Appboard/2.5/builder/widgets/topology/selfref example - Revision history

imported>Jason.nicholls: /* Create a new Data Source */

2014-09-23T13:38:25Z

Create a new Data Source

← Older revision		Revision as of 13:38, 23 September 2014
Line 19:		Line 19:
	# On the ''Associate'' step we need to configure the relationship between the two entities above:		# On the ''Associate'' step we need to configure the relationship between the two entities above:
	## Use the ''Add Association'' button to add the following associations:		## Use the ''Add Association'' button to add the following associations:
	##* <tt>training.NetworkNodes.UID</tt> ''EQUALS'' <tt>training.NetworkTopology.fromID</tt><br>''Name'': <tt>~~node~~</tt>, ''Type'': ''One to Many''		##* <tt>training.NetworkNodes.UID</tt> ''EQUALS'' <tt>training.NetworkTopology.fromID</tt><br>''Name'': <tt>links</tt>, ''Type'': ''One to Many''
	##* <tt>training.NetworkTopology.toID</tt> ''EQUALS'' <tt>training.NetworkNodes.UID</tt><br>''Name'': <tt>~~links~~</tt>, ''Type'': ''One to One''		##* <tt>training.NetworkTopology.toID</tt> ''EQUALS'' <tt>training.NetworkNodes.UID</tt><br>''Name'': <tt>node</tt>, ''Type'': ''One to One''
	# Click the ''Finish'' button to exit the wizard and save the new data source.		# Click the ''Finish'' button to exit the wizard and save the new data source.

imported>Jason.nicholls: /* Create a new Data Source */

2014-09-23T13:37:29Z

Create a new Data Source

← Older revision		Revision as of 13:37, 23 September 2014
Line 19:		Line 19:
	# On the ''Associate'' step we need to configure the relationship between the two entities above:		# On the ''Associate'' step we need to configure the relationship between the two entities above:
	## Use the ''Add Association'' button to add the following associations:		## Use the ''Add Association'' button to add the following associations:
	##* <tt>training.NetworkNodes.UID</tt> ''EQUALS'' <tt>training.NetworkTopology.fromID</tt><br>''Name'': <tt>node</tt>, ''Type'': ''One		##* <tt>training.NetworkNodes.UID</tt> ''EQUALS'' <tt>training.NetworkTopology.fromID</tt><br>''Name'': <tt>node</tt>, ''Type'': ''One to Many''
	to Many''
	##* <tt>training.NetworkTopology.toID</tt> ''EQUALS'' <tt>training.NetworkNodes.UID</tt><br>''Name'': <tt>links</tt>, ''Type'': ''One to One''		##* <tt>training.NetworkTopology.toID</tt> ''EQUALS'' <tt>training.NetworkNodes.UID</tt><br>''Name'': <tt>links</tt>, ''Type'': ''One to One''
	# Click the ''Finish'' button to exit the wizard and save the new data source.		# Click the ''Finish'' button to exit the wizard and save the new data source.

imported>Jason.nicholls: /* Create a new Data Source */

2014-09-23T13:37:13Z

Create a new Data Source

← Older revision		Revision as of 13:37, 23 September 2014
Line 19:		Line 19:
	# On the ''Associate'' step we need to configure the relationship between the two entities above:		# On the ''Associate'' step we need to configure the relationship between the two entities above:
	## Use the ''Add Association'' button to add the following associations:		## Use the ''Add Association'' button to add the following associations:
			##* <tt>training.NetworkNodes.UID</tt> ''EQUALS'' <tt>training.NetworkTopology.fromID</tt><br>''Name'': <tt>node</tt>, ''Type'': ''One
			to Many''
	##* <tt>training.NetworkTopology.toID</tt> ''EQUALS'' <tt>training.NetworkNodes.UID</tt><br>''Name'': <tt>links</tt>, ''Type'': ''One to One''		##* <tt>training.NetworkTopology.toID</tt> ''EQUALS'' <tt>training.NetworkNodes.UID</tt><br>''Name'': <tt>links</tt>, ''Type'': ''One to One''
	~~##* <tt>training.NetworkNodes.UID</tt> ''EQUALS'' <tt>training.NetworkTopology.fromID</tt><br>''Name'': <tt>node</tt>, ''Type'': ''One to Many''~~
	# Click the ''Finish'' button to exit the wizard and save the new data source.		# Click the ''Finish'' button to exit the wizard and save the new data source.

imported>Jason.nicholls: /* Viewing the Topology Widget */

2014-09-23T13:31:16Z

Viewing the Topology Widget

← Older revision		Revision as of 13:31, 23 September 2014
Line 91:		Line 91:
	# Use the mouse to drag (click and drag) and zoom in or out (mouse wheel up or down) on the widget as needed.		# 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.		# Different nodes in the diagram can be clicked to perform a drill down and see connections at different levels in the hierarchy.

			[[File:appboard-2.5-topology-example-final.png\|frame\|center\|The completed TopologyExample]]

imported>Jason.nicholls: /* Creating the Topology Widget */

2014-09-23T13:26:37Z

Creating the Topology Widget

← Older revision		Revision as of 13:26, 23 September 2014
Line 69:		Line 69:
	== Creating the Topology Widget ==		== Creating the Topology Widget ==

	# ~~Navigate to~~ the '''~~Widgets~~'~~'' page~~ and ~~click~~ the '''~~Add~~''' ~~button to open the~~ '''~~Widget Wizard~~'''.		# Select the ''Builder'' mode, and the <tt>TopologyExample</tt> stack.
	# ~~Click the '~~''Widget Type''~~' button and select~~ ''Diagrams'' ~~and choose~~ ''Topology''~~. Click~~ '''~~Use Selected~~'~~''.~~		# Click the ''Add Widget'' quick action:
	# ~~Click the '~~''Data Collection''~~' dropdown list and select ''~~TopologyExampleRouters~~''.~~		## The ''Add Widget Wizard'' should launch on the ''Data'' step:
	# ~~Enter "TopologyExample" for~~ the ''~~'Widget Name'~~''. ~~Click~~ '''~~Next~~'~~''.~~		##* ''Widget Type'': ''Diagrams'' -> ''Topology''
	# ~~Click the '~~''Relationship Model''~~' dropdown list and select ''~~TopologyExampleModel~~''.~~		##* ''Widget Name'': <tt>TopologyExample</tt>
	# ~~Set the '''Default Layout''' to ''Hierarchical Cyclic'' if it is not already selected and set '''Auto Node Drill Down''' to ''Enabled''.~~		##* ''Data Collection'': <tt>TopologyExampleRouters</tt>
	# ~~'''[Optional]''' Click the '''Link Arrows''' dropdown list and choose ''Directional'', and increase the '~~''Max Number of Hops''~~' to see different levels of~~ the ~~hierarchy~~. ~~[[Image:SRTopology_WWVisualization.PNG\|thumb\|center\|700px\|Topology Widget Visualization]]~~		##* Click the ''Next'' button.
	# Click '''Next''~~' and then click '''Finish'''~~.		## On the ''Visualization'' step:
	# ~~Select~~ ''~~TopologyExample~~'' ~~in the list of widgets and~~ click ~~the~~ '''~~Board~~'~~'' column~~ to ~~change~~ the board ~~to ''TopologyExample''~~.		##* ''Relationship Model'': <tt>TopologyExampleModel</tt>
			##* ''Max Number of Hops'': <tt>3</tt>
			##* [optional] try out the other visualization options.
			##* Click the ''Next'' button.
			## No need to do anything on the ''Options'' step, just click ''Finish'' to complete the wizard.
			# You should now have a topology diagram on the board.

			[[Image:appboard-2.5-topology-example-visualization.png\|frame\|center\|Topology Widget Visualization]]

	== Viewing the Topology Widget ==		== Viewing the Topology Widget ==

imported>Jason.nicholls: /* Creating a Root-level Data Collection */

2014-09-23T13:14:53Z

Creating a Root-level Data Collection

← Older revision		Revision as of 13:14, 23 September 2014
Line 55:		Line 55:
	# On the '''Data Collections''' page, switch the '''Collection Type''' to the '''Flat Collection''' mode by clicking on the toggle switch.		# 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.		# Click '''Add''' create a new data collection.
	# For the '''Data Collection Name''', enter "TopologyExampleRouters" and in the '''Data Source''' dropdown list, select ~~''TopologyExample~~.NetworkNodes''.		# For the '''Data Collection Name''', enter "TopologyExampleRouters" and in the '''Data Source''' dropdown list, select <tt>training.NetworkNodes</tt>.
	# Check the '''Filter''' option and click '''Add Rule'''.		# Check the '''Filter''' option and click '''Add Rule'''.
	# In the '''Property''' dropdown list, select ''Type''.		# In the '''Property''' dropdown list, select ''Type''.
	# Leave '''Comparator''' as ''='' and set '''Value''' to "Router".		# Leave '''Comparator''' as ''='' and set '''Value''' to "Router".
	# Click '''OK'''.		# Click '''OK'''.


	== Creating a Stack ==		== Creating a Stack ==

imported>Jason.nicholls: /* Create a new Relationship Model */

2014-09-23T13:12:00Z

Create a new Relationship Model

← Older revision		Revision as of 13:12, 23 September 2014
Line 31:		Line 31:
	# For the '''Model Name''', enter <tt>TopologyExampleModel</tt>.		# For the '''Model Name''', enter <tt>TopologyExampleModel</tt>.
	# First we need to add the “root” node type for our model. Click the '''Add Source''' button and pick <tt>training.NetworkNodes</tt>		# First we need to add the “root” node type for our model. Click the '''Add Source''' button and pick <tt>training.NetworkNodes</tt>
	# 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 <tt>links.node</tt>. Leave the '''Relationship Type''' as ''Child''. Click '''Finish'''.		# 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 <tt>links.node</tt>. Leave the '''Relationship Type''' as ''Child''. Click '''Finish'''. [[Image:appboard-2.5-topology-example-relation-editor.png\|frame\|center\|Relation Model Editor]]
	: [[Image:appboard-2.5-topology-example-relation-editor.png\|frame\|center\|Relation Model Editor]]
	# To describe the data with appearance rules, click the '''yellow “/” button'''.		# 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'''.		# In the window that appears, on the '''Label''' page, select the ''Name'' token to use it in the '''Label'''.

imported>Jason.nicholls: /* Create a new Relationship Model */

2014-09-23T13:11:33Z

Create a new Relationship Model

← Older revision		Revision as of 13:11, 23 September 2014
Line 31:		Line 31:
	# For the '''Model Name''', enter <tt>TopologyExampleModel</tt>.		# For the '''Model Name''', enter <tt>TopologyExampleModel</tt>.
	# First we need to add the “root” node type for our model. Click the '''Add Source''' button and pick <tt>training.NetworkNodes</tt>		# First we need to add the “root” node type for our model. Click the '''Add Source''' button and pick <tt>training.NetworkNodes</tt>
	# 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 <tt>links.node</tt>. Leave the '''Relationship Type''' as ''Child''. Click '''Finish'''.[[Image:~~SRTopology_RME~~.~~PNG~~\|~~thumb~~\|center~~\|700px~~\|Relation Model Editor]]		# 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 <tt>links.node</tt>. Leave the '''Relationship Type''' as ''Child''. Click '''Finish'''.
			: [[Image:appboard-2.5-topology-example-relation-editor.png\|frame\|center\|Relation Model Editor]]
	# To describe the data with appearance rules, click the '''yellow “/” button'''.		# 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'''.		# In the window that appears, on the '''Label''' page, select the ''Name'' token to use it in the '''Label'''.

imported>Jason.nicholls: /* Create a new Relationship Model */

2014-09-23T13:08:42Z

Create a new Relationship Model

← Older revision		Revision as of 13:08, 23 September 2014
Line 29:		Line 29:
	# Navigate to the '''Data Collections''' page and switch the '''Collection Type''' to the '''Relationship''' mode by clicking on the toggle switch.		# 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.		# Click the '''Add''' button to launch the relationship model editor.
	# For the '''Model Name''', enter "TopologyExampleModel".		# For the '''Model Name''', enter <tt>TopologyExampleModel</tt>.
	# First we need to add the “root” node type for our model. Click the '''Add Source''' button and pick ~~''TopologyExample~~.NetworkNodes''		# First we need to add the “root” node type for our model. Click the '''Add Source''' button and pick <tt>training.NetworkNodes</tt>
	# 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]]		# 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 <tt>links.node</tt>. 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'''.		# 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'''.		# In the window that appears, on the '''Label''' page, select the ''Name'' token to use it in the '''Label'''.
Line 50:		Line 50:
	# If the Icon Filter dropdown list does not say ''Icon Rule'', click the list and select ''Icon Rule''.		# 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'''.		# 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 ==		== Creating a Root-level Data Collection ==

imported>Jason.nicholls: /* Create a new Data Source */

2014-09-23T13:06:14Z

Create a new Data Source

← Older revision		Revision as of 13:06, 23 September 2014
Line 23:		Line 23:
	# Click the ''Finish'' button to exit the wizard and save the new data source.		# Click the ''Finish'' button to exit the wizard and save the new data source.

	[[Image:~~SRTopology_DSAssociate~~.~~PNG~~\|~~thumb~~\|center~~\|700px~~\|Associations]]		[[Image:appboard-2.5-topology-example-associate.png\|frame\|center\|Associations]]

	== Create a new Relationship Model ==		== Create a new Relationship Model ==