README.wiki

SOAGraph

Table of Contents Parameters Example Enabling Example data shown using soagraph format Same example data shown using graph format

Alternative or extension to Graph SemanticResultFormats

This is an example page for the result format soagraph, part of the Semantic Result Formats extension, which can be used to display result values as a graph showing the relation between services in a Service Oriented Architecture (SOA). In order to work the GraphViz extension is required to be installed, too.

This result format soagraph works similarly to the graph format in displaying a network of nodes. The main difference is that the soagraph format offers the option to define a number of start nodes. The resulting graph then only shows those network elements which have a relation with one of these start nodes. Each node can have one or more child relations defined with other nodes using a named node property. The name of the property defining the relation can be specified in the parameter columnTo. When building the graph to show, the tree is traversed both upwards and downwards. More parameters are shown in the table below.

Parameters

Parameter	Type	Default	Notes
graphName	String	QueryResult	Names the graph
graphSize	pointf	none	Specifies the size of the graph
startColor	color	yellow	The color of the nodes defined as starting point for the tree
arrowDirection	LR,RL,TB or BT	LR	Specifies the direction of the graph L=left,R=right,T=top,B=bottom
nodeShape	shape	none	Sets the shape of graph nodes. Allowed values: box, box3d, circle, component, diamond, doublecircle, doubleoctagon, egg, ellipse, folder, hexagon, house, invhouse, invtrapezium, invtriangle, Mcircle, Mdiamond, Msquare, none, note, octagon, parallelogram, pentagon , plaintext, point, polygon, rect, rectangle, septagon, square, tab, trapezium, triangle, tripleoctagon
columnTo	text	none	The name of the property containing a reference to the child of this node
startNodes	text	none	The names of the nodes defined as starting point for the tree
columnFillColor	text	none	The property used to define the fill color of this node
fillColorMap	text	none	A comma-separated list of "<value></value>=color" pairs used to define the fill color of a node with that property defined. Properties may look like this "fillColorMap=design=gray,test=gray,production=green"
columnFontColor	text	none	The name of the property used to define the font color of this node
fontColorMap	text	none	A comma-separated list of "<value></value>=color" pairs used to define the font color of a node with that property defined. Properties may look like this "fontColorMap=design=gray,test=gray,production=green"
defaultFillColor	color	none	The default fill color of a node when none of the defined property values match
defaultFontColor	color	none	The default font color of a node when none of the defined property values match
defaultShape	shape	none	The default shape of a node when none of the defined property values match
columnColor	text	none	The name of the property containing the value to define the color of this node
colorMap	text	none	A comma-separated list of "<value></value>=color" pairs used to define the color of a node with that property defined. Properties may look like this "colorMap=design=gray,test=gray,production=green"
startFillColor	color	#ffffff	The fill color of the nodes defined as starting point for the tree
startFontColor	color	#ffffff	The font color of the nodes defined as starting point for the tree
startColor	color	#0000aa	The color of the nodes defined as starting point for the tree
startShape	shape	shape=box	The shape of the nodes defined as starting point for the tree
columnShape	text	none	The name of the property containing the value to define the shape of this node
shapeMap	text	none	A comma-separated list of "<value></value>=shape" pairs used to define the shape of a node with that property defined. Properties may look like this "shapemap=FE=triangle,FEA=box"
debug	text	none	If this parameter contains any value, the output shows the text used to define the graph

Example

&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;123&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;123&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;35&amp&#59;&#35&#59;59&#59&#59;ask&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;58&amp&#59;&#35&#59;59&#59&#59;format&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;soagraph
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; graphsize&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;123&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;123&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;123&amp&#59;&#35&#59;59&#59&#59;size&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59;8.3,11.7&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;125&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;125&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;125&amp&#59;&#35&#59;59&#59&#59;
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; columnTo&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;Service Afhankelijkheid
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; startNodes&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;Service/Regeling_Klok/1
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; startFillColor&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;35&amp&#59;&#35&#59;59&#59&#59;ff8030
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; startColor&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;black
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; startShape&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;oval
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; columnShape&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;Rol
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; shapeMap&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;FE&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;triangle,FEA&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;box,CS&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;box,BEA&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;box,BE&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;invtriangle
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; columnlabel&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;Service Fullname
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; limit&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59;10000
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;91&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;91&amp&#59;&#35&#59;59&#59&#59;Category&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;58&amp&#59;&#35&#59;59&#59&#59;Service&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;93&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;93&amp&#59;&#35&#59;59&#59&#59;
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; ?Service Fullname
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; ?Service Afhankelijkheid
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; ?Rol
  &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;124&amp&#59;&#35&#59;59&#59&#59; ?Status
&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;125&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;125&amp&#59;&#35&#59;59&#59&#59;

Enabling

This result format is not enabled by default on a wiki. To enable it the line

$srfgFormats&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;91&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;93&amp&#59;&#35&#59;59&#59&#59; &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;61&amp&#59;&#35&#59;59&#59&#59; &amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;39&amp&#59;&#35&#59;59&#59&#59;soagraph&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;39&amp&#59;&#35&#59;59&#59&#59;&amp&#59;amp&#59&#59;&amp&#59;&#35&#59;35&#59&#59;59&amp&#59;&#35&#59;59&#59&#59;

must be added to the file LocalSettings.php below the inclusion of the Semantic Result Formats extension.

Example data shown using soagraph format

https://github.com/DeBAAT/SOAGraph/blob/master/Example_SOAGraph.png|center|100px|caption

This image only shows the services related to the start node Service/Regeling_Klok/1.

Same example data shown using graph format

https://github.com/DeBAAT/SOAGraph/blob/master/Example_Graph.png|center|100px|caption

This image shows all services available in the wiki.