NightWatchman Enterprise

The following takes place when a NightWatchman event is triggered.

To learn how to configure NightWatchman or modify its scripts, see configuring NightWatchman. To learn about the switches that control NightWatchman functionality, see command-line switches.

The following example sets the namespaces required for a table tile.

<?xml version="1.0" encoding="unicode" ?>
<DashboardTile xmlns="http://www.1e.com/2009/DashboardTile.xsd" 
               xmlns:res="http://www.1e.com/2009/DashboardResources.xsd" 
               xmlns:para="http://www.1e.com/2009/StandardParagraph.xsd"
               xmlns:table="http://www.1e.com/2009/StandardTable.xsd"
   Type="Standard"
   Title="ACME Happy Table" 
   ThumbnailSource="table.png"
   Description="This table lets you know the ACME approval rating!" 
   RefreshFrequencyMins="60"
   Activator="StandardListViewActivator">

The example can use exactly the same command used in the previous chart tile example.

<CommandCollection>
   <Command DataSource="ACME" Identifier="ACMESAT">
      <Text><![CDATA[SELECT Happiness, Employees, Customers, Investors FROM dbo.Happy]]></Text>
   </Command>
</CommandCollection>

The <Presentation> tag this time contains a single <table:StandardTable> definition, where table is an object name declared in a namespace definition in the tile's <DashboardTile> tag. The <table:ColumnCollection> tag defines general parameters for the table and holds the individual <table:Column> tag definitions.

The <table:ColumnCollection> tag sets the ACMESAT command to populate the table, turns off displaying of the column headings and sets the background color for the table to a green/blue color.

<Presentation>
   <table:StandardTable >
      <table:ColumnCollection CommandIdentifier="ACMESAT"     
                              ShowColumnHeader="false" 
                              BackgroundColor="#FF008888">

The following <table:Column> tag sets the data that will be displayed in the column using the Binding parameter. It also sets the column title, the column width and height and the height of the column heading.

The type of the column is set to html this allows HTML formatting to be applied to the contents of the column using the <table:FormatString> tag.

The Happiness binding is referenced in the format string using the {parameter} syntax. This substitutes the value for the binding into that location in the format string so in this example the column will display the Happiness value with a font size of 24 and with the emphasis style.

The CDATA syntax is used to allow the format string to contain characters that would normally require escape characters in XML.

<table:Column  Binding="Happiness" 
       Title="Happy" 
       Width="300" ContentHeight="60" Type="html">
   <table:FormatString>
      <![CDATA[<font size="24"><em>{Happiness}</em></font>]]>
   </table:FormatString>
</table:Column >

The following column definitions complete the table column collection.

<table:Column Binding="Employees" Title="Employees" Type="html" Width="300" ContentHeight="60" >
   <table:FormatString>
      <![CDATA[<font size="24">{Employees}</font>]]>
   </table:FormatString>
</table:Column >
<table:Column Binding="Customers" Title="Customers" Type="html" Width="300" ContentHeight="60" >
   <table:FormatString>
      <![CDATA[<font size="24">{Customers}</font>]]>
   </table:FormatString>
</table:Column >
<table:Column Binding="Investors" Title="Investors" Type="html" Width="300" ContentHeight="60" >
   <table:FormatString>
      <![CDATA[<font size="24">{Investors}</font>]]>
   </table:FormatString>
</table:Column >
</table:ColumnCollection>

In this example we also include a <StandardParagraph> tag that will display some descriptive text when the tile is maximized. This tag must be placed inside the <table:StandardTable> tag and only one is allowed.

<para:StandardParagraph>
   <para:Paragraph>
      <![CDATA[This table shows the happiness factor for the ACME corporation from the perspective of employees, customers and investors.]]>
   </para:Paragraph>
</para:StandardParagraph>
</table:StandardTable>
    </Presentation>
</DashboardTile>

Using the same data as in the previous chart example, this table definition results in the tile.

The tiles require data sources to display anything useful. The data sources must be added to the DataSources.xml file in the Enterprise View\Dashboard.Web\Source directory. By default the DataSources.xml file contains four data sources: Dashboard, NightWatchman, NightWatchmanServer and LOCAL.

The Dashboard data source relates to the Enterprise View settings, the NightWatchman and NightWatchmanServer relate to the data held by NightWatchman Management Center and NightWatchman Server Edition products. The fourth default data source called LOCAL refers to a local directory where you can store and retrieve XML data.

 ACME\ACMESVR030$

<DataSource Name="ACME">
   <ConnectionProperties DataProvider="SQL">
      <Value>
         <![CDATA[Server=(local);Database=ACME;Trusted_Connection=True;pooling=false]]>
      </Value>
   </ConnectionProperties>
</DataSource>

Enterprise View\Dashboard.Web\Source\LocalData

<?xml version="1.0" encoding="utf-8"?>

ColumnName1="Value1" ColumnName2="Value2"

<?xml version="1.0" encoding="utf-8"?>
<Result>
   <Row Id="0" Month="Sep 09" PCSaving="25399.00" ServerSaving="2500"/>
   <Row Id="1" Month="Oct 09" PCSaving="23872.00" ServerSaving="2389"/>
   <Row Id="2" Month="Nov 09" PCSaving="24977.00" ServerSaving="2700"/>
   <Row Id="3" Month="Dec 09" PCSaving="24293.00" ServerSaving="3214"/>
   <Row Id="4" Month="Jan 10" PCSaving="24556.00" ServerSaving="2847"/>
   <Row Id="5" Month="Feb 10" PCSaving="25675.00" ServerSaving="2837"/>
</Result>

The contents of the tile definition file must start with the xml version and encoding tag:

<?xml version="1.0" encoding="unicode" ?>

The tile definition must be placed in the <DashboardTile></DashboardTile> tag. The attributes for this tag lets you define general attributes for the tile, including the schemas for any presentation elements the tile definition uses and the tile's title, description and type. The following parameters can be set in the DashboardTile tag:

xmlns:res="http://www.1e.com/2009/DashboardResources.xsd"

<res:ResourceDictionary Language="en-US">

Each tile command is used to gather information from a particular data source. You can have a number of commands defined in a single command collection each referring to the same or a different data source. All the commands must be placed in a single <CommandCollection></CommandCollection> tag, usually as the first element inside the DashboardTile tag.

The command definition must provide the name for a data source defined in the DataSources.xml file and an identifier that will be used to run the command in a presentation element. The command identifier must be unique within the tile definition but this is not checked by Enterprise View – you will need to ensure this is the case.

Each command must be defined using the <Command></Command> tag using the following format:

<Command DataSource="DataSourceName" Identifier="CommandID">
   <Text>
      Command... 
   </Text>
</Command>

where DataSourceName and CommandID is the data source and command identifier respectively and Command... is the command to run.

<Command DataSource="ACME" Identifier="ACMECMD">
   <Text>
      <![CDATA[ SELECT Rating, Number FROM dbo.UserSatisfaction ]]>
   </Text>
</Command>

<Command DataSource="LOCAL" Identifier="DEPTCOST">
   <Text>DepartmentCost.xml</Text>
</Command>

When using the table presentation element, include the following namespace definition in the DashboardTile element. The table definition in the presentation section uses the table object name:

xmlns:table="http://www.1e.com/2009/StandardTable.xsd"

The outer element for a table definition is <table:StandardTable></table:StandardTable> all other atrributes must be placed inside this. The columns for the table definition must be placed within <table:ColumnCollection></table:ColumnCollection>. The following attributes can be set for ColumnCollection:

#OPRRGGBB

BackgroundColor="FF00FF00"

Inside <table:ColumnCollection>, add the <table:Column> attributes that define the actual contents of the table. The following attributes can be set for Column:

You can place a single standard paragraph in either the StandardTable or the StandardChart element. It must be placed inside the element but outside the ColumnCollection or SeriesCollection. The paragraph uses a limited subset of HTML 4 for formatting the text. See Supported HTML 4 tags for further details.

When using the table presentation element you could include the following namespace definition in the DashboardTile element, the table definition in the presentation section uses the table object name:

xmlns:chart="http://www.1e.com/2009/StandardChart.xsd"

The outer element for a chart definition is <chart:StandardChart></chart:StandardChart> all other chart attribute are placed within this. The following attributes can be set for StandardChart:

All the data series required for the chart should be placed inside the <chart:SeriesCollection></chart:SeriesCollection> element. Each data series is defined using <chart:Series></chart:Series>. The following attributes can be set for Series:

Chart types

The following table shows the chart types available for use with Enterprise View. The chart names are case sensitive so you need to be careful with capitalization of the chart names when adding them to the tile definitions.

Chart type	Chart	Notes
Area		Displays an area chart. This is a line chart that is filled to the X axis.
Bar		Displays a bar chart, where the y value for each value of x is shown as a horizontal bar.
Column		Displays a column chart, where the y value for each value of x is shown as a vertical bar.
Doughnut		Displays a doughnut chart, where the y value for each distinct value of x is displayed as a sector of a ring. This shows the proportion between the distinct values.
Line		Displays a line chart, where the y value is plotted against each distinct value for x.
Pie	>	Displays a pie chart, where the y value for each distinct value of x is displayed as a sector of a circle. This shows the proportion between the distinct values.
Point		Displays a point chart, where the y value is plotted against each distinct value for x.
SectionFunnel		A section funnel chart is displayed as an inverted pyramid, where the shape of the chart is fixed and the different values are shown as layers inside. This allows the relative sizes of the values to be determined whilst indicating a general importance relationship between the parameters shown at the top and the ones at the bottom.
StackedArea		The stacked area chart shows each set of y values as area charts stacked above one another. This allows easy visualization of the proportions between the values and how these proportions change with the corresponding x values.
StackedArea100		The stacked area 100 chart shows a stacked area chart where each set of y values is adjusted to show the percentage relationship between the individual values.
StackedBar		The stacked bar chart shows each set of y values as bars stacked beside one another. This allows easy visualization of the proportions between the values and how these proportions change with the corresponding x values.
StackedBar100		The stacked bar 100 chart shows a stacked bar chart where each set of y values is adjusted to show the percentage relationship between the individual values.
StackedColumn		The stacked bar chart shows each set of y values as bars stacked beside one another. This allows easy visualization of the proportions between the values and how these proportions change with the corresponding x values.
StackedColumn100		The stacked bar 100 chart shows a stacked bar chart where each set of y values is adjusted to show the percentage relationship between the individual values.
StreamLineFunnel

When using the standard single value presentation element you would include the following namespace definition in the DashboardTile element, the definition in the presentation section would subsequently use the value object name:

xmlns:value="http://www.1e.com/2009/StandardSingleValue.xsd"

The only standard single value type currently supported is the Gauge. This takes a single data binding and displays the value on a speedometer. Gauges require that the Activator attribute in the DashboardTile element is set to GaugeActivator.

By default, there are no permissions defined. This means that all users have access to Enterprise View. Enterprise View handles tile permissions through definitions for roles and users. The roles are defined with the specific tiles they are able to view and users are then associated with these roles.

Tile access is configured by creating the following file in:

%programfiles%\1E\Dashboard\Dashboard.Web\Source\TileAuthorization.xml

An empty version of the file contains the following:

<?xml version="1.0" encoding="utf-8" ?> <Authorization xmlns="http://www.1e.com/2009/TileAuthorization.xsd"> </Authorization>

Roles are defined within the <Role> element which has the following attributes:

Adding an exception to the role definition counteracts the default permission for the role for a particular tile. You can either leave the default permission for the role as Allowed and define exceptions for tiles where access is denied, or you can set the default permission to Denied and define exceptions where access is allowed.

The following illustrates a definition where Developers have access to all tiles except FirstTile and SecondTile:

<Role 
   Name="Developers" 
   Description="Developers and Technicians Role" >
   <Exception TileIdentifier="FirstTile"/>
   <Exception TileIdentifier="SecondTile"/>
</Role>

The following illustrates a definition where Developers cannot access any tiles except FirstTile and SecondTile.

<Role 
   Name="Developers" 
   Description="Developers and Technicians Role" 
   DefaultPermission="Denied" >
   <Exception TileIdentifier="FirstTile"/>
   <Exception TileIdentifier="SecondTile"/>
</Role>

Having defined the roles, you associate them with specific users. This is done with <RoleAccountMapping> which has a single attribute that specifies the role being associated.

Next, you add account definitions for each user you want to associate with the named role. This is done with <Account> which has a single attribute that specifies the user account:

For example, the following sets a user for the Developers role defined earlier:

<RoleAccountMapping Role="Developers">
   <Account Name = "ACME\Ned.Zeppelin" />
</RoleAccountMapping>

To enable globalization and resources for a particular tile, add the following to the DashboardTile tag:

xmlns:res="http://www.1e.com/2009/DashboardResources.xsd"

The resource dictionary and setter definitions use the object name ref. The resources are defined in <Resources></Resources>. Each collection of language resources are defined in <res:ResourceDictionary></res:ResourceDictionary> which has a single attribute that defines the language code used.

The contents of a resource dictionary consist of <res:Setter> entries where you can set the following attributes:

For example, the following illustrates a resource setter for a en-US resource dictionary:

<Resources>
<res:ResourceDictionary Language="en-US">
   <res:Setter Property="Title" Value="Aluminum" />
</res:ResourceDictionary>

and the following is the equivalent resource for an en-GB resource dictionary:

<Resources>
<res:ResourceDictionary Language="en-GB">
   <res:Setter Property="Title" Value="Aluminium" />
</res:ResourceDictionary></Resources>

This is referenced in the DashboardTile element for a tile definition as follows:

<DashboardTile xmlns="http://www.1e.com/2009/DashboardTile.xsd" 
               xmlns:res="http://www.1e.com/2009/DashboardResources.xsd" 
   Title="{Title}" 
   …rest of tag definition…>

When viewing the tile, it is displayed as Aluminum or Aluminium depending on the en-US or en-GB language set.

<?xml version="1.0" encoding="utf-8" ?>
<Dashboard xmlns="http://www.1e.com/2009/Dashboard.xsd">
  <Tile Path="NWMPowerSchemeCompliance.xml"/>
  <Tile Path="NWMSavingsToDate.xml"/>
  <Tile Path="NWMDailyPowerCost.xml"/>
  <Tile Path="NWMInstalledOperatingSystems.xml"/>
  <Tile Path="NWMMonthlySavings.xml"/>
  <Tile Path="NWMEnergyCostPerCapita.xml"/>
  <Tile Path="NWMTopFiveHardwareTypes.xml"/>
  <Tile Path="NWMTopFiveWorstHardwareTypes.xml"/>
</Dashboard>