[ Back to Sprockit home page ]

sprockitviz

This page provides technical information for executing and configuring sprockitviz – if you are unfamiliar with the application you should first read Sprockit ETL pipeline visualisation.

sprockitviz is executed from the Windows command line with a single, mandatory argument identifying the Sprockit instance to be visualised:

sprockitviz.exe MySprockitInstance

The specified argument must correspond to the value of an <Instance> node's alias attribute defined in sprockit.exe.config.

sprockitviz is configured in the associated configuration file, sprockit.exe.config. This is a standard .Net application configuration file – do not modify elements of the file other than those described here.

Configuration elements related to sprockitviz are confined to the <FireFive.PipelineVisualiser.SprockitViz> node of the file, e.g.:

  <FireFive.PipelineVisualiser.SprockitViz
    graphvizAppFolder="C:\Program Files (x86)\Graphviz2.38\bin"
    deleteWorkingFiles="true"
    verbose="false">
 
    <SprockitInstances>
 
      <Instance
        alias="my_test_sprockit_instance"
        connectionString="Server=DbServer1;Database=SprockitDb;Trusted_Connection=yes;"
        outputFolder="C:\tmp\sprockitviz\db1"
        maxWidth="4"
        maxHeight="6" >
      </Instance>
 
      <Instance
        alias="my_second_sprockit_instance"
        connectionString="Server=DbServer2;Database=SprockitDb;Trusted_Connection=yes;"
        graphType="compact"
        outputFolder="C:\tmp\sprockitviz\db2"
        subgraphRadius="2"
        maxWidth="4"
        maxHeight="6"
        displayMode="basic" >
        <dbColors>
          <dbColor dbName="Cornflower" color="cornflowerblue" />
          <dbColor dbName="Forest" color="forestgreen" />
        </dbColors>
      </Instance>     
 
    </SprockitInstances>
  </FireFive.PipelineVisualiser.SprockitViz>

The <FireFive.PipelineVisualiser.SprockitViz> element has the following features:

  • attribute graphvizAppFoldermandatory; provides the folder location of Graphviz's dot.exe executable;
  • attribute deleteWorkingFiles – optional, defaults to true. If false, dot script files produced as inputs to Graphviz are not deleted after use.
  • attribute verbose – optional, defaults to false. If true, additional information is displayed during sprockitviz execution (including full exception stack traces on error).
  • child element <SprockitInstances>mandatory; contains zero or more <Instance> child elements, each describing an instance of Sprockit for possible visualisation by sprockitviz.

An Instance element describes an instance of Sprockit that can be visualised by sprockitviz. Each instance element has some or all of the following features:

  • attribute aliasmandatory; a label identifying the Sprockit instance uniquely within sprockitviz.exe.config.
  • attribute connectionStringmandatory; a SQL Server connection string specifying the SQL Server instance and database where Sprockit is installed, along with necessary credential information.
  • attribute outputFoldermandatory; indicates the folder location where sprockitviz should write its output files. This folder must exist.
  • attribute maxWidthmandatory; the greatest number of nodes that can usually be accommodated side-by-side on the screen of a user viewing node-centric visualisations. This value will not change what information is included in a diagram but may influence its layout.
  • attribute maxHeightmandatory; the greatest number of nodes that can usually be accommodated top-to-bottom on the screen of a user viewing node-centric visualisations. This value will not change what information is included in a diagram but may influence its layout.
  • attribute subgraphRadius – optional, defaults to zero. A value greater than zero will fix the size of an object's neighbourhood in subgraph diagrams. A value of zero will allow sprockitviz to explore different radius values, finding the largest neighbourhood that can be contained with maxWidth and maxHeight – this can produce outputs of greater usefulness but may take longer to do so.
  • attribute graphType – optional, defaults to compact. No other options supported currently.
  • attribute displayMode – optional, defaults to basic. No other options supported currently.
  • child element dbColors – optional. Contains zero or more <dbColor> elements, each specifying a text colour for objects of a named database.

A dbColor element specifies a text colour for objects of a named database. Each element has the following attributes:

  • attribute dbNamemandatory; indicates the database to which this element relates. Must be unique within the <dbColors> parent collection.
  • attribute dbColormandatory; indicates the colour text in which the names of objects from the identified database are to be rendered. Permitted colour names are those defined in Graphviz's X11 color scheme.