User Help > Viewing Project Data in Dashboards > Creating a Dashboard in XML
  
Creating a Dashboard in XML
When you create a dashboard using the Windchill RV&S dashboard designer (see “Creating a Dashboard”), Windchill RV&S saves your dashboard layout files in XML format in the database. If you prefer to create a dashboard directly in XML without using the dashboard designer, it must conform to a specific document type definition (DTD).
If you create a dashboard directly in XML, you may not be able to edit it using the Windchill RV&S dashboard designer.
The content for the Dashboard DTD is as follows:
<!-- DashboardLayout is the root element for the
layout definition -->
<!ELEMENT DashboardLayout (Styles?,Grids?)>
<!ATTLIST DashboardLayout backgroundColor CDATA #IMPLIED>
<!ATTLIST DashboardLayout version CDATA #IMPLIED>
<!--Styles contain the user defined text styles and the
default style assignments for the layout-->
<!ELEMENT Styles (TextStyle*,DefaultStyles?)>
<!--TextStyle defines a user defined style-->
<!ELEMENT TextStyle EMPTY>
<!ATTLIST TextStyle fontColor CDATA #IMPLIED>
<!ATTLIST TextStyle fontName CDATA #IMPLIED>
<!ATTLIST TextStyle fontSize CDATA #IMPLIED>
<!ATTLIST TextStyle fontStyle ( bold | italic |
bolditalic | plain) "plain">
<!-- The id of the text style is how other elements
reference this text style, currently should be the
same as the name-->
<!ATTLIST TextStyle id id #IMPLIED>
<!ATTLIST TextStyle name CDATA #REQUIRED>
<!--DefaultStyles defines what styles (by id) are
to be assigned to what elements-->
<!ELEMENT DefaultStyles EMPTY>
<!ATTLIST DefaultStyles label idref #IMPLIED>
<!ATTLIST DefaultStyles querylink idref #IMPLIED>
<!ATTLIST DefaultStyles reportlink idref #IMPLIED>
<!ATTLIST DefaultStyles urllink idref #IMPLIED>
<!--Grids is the container for all Grid elements-->
<!ELEMENT Grids (DefaultGridProperties?,
DefaultCellProperties?,Grid*)>
<!--DefaultGridProperties define the default
attributes of all grids-->
<!ELEMENT DefaultGridProperties EMPTY>
<!ATTLIST DefaultGridProperties backgroundColor
CDATA #IMPLIED>
<!ATTLIST DefaultGridProperties border CDATA
#IMPLIED>
<!ATTLIST DefaultGridProperties cellpadding
CDATA #IMPLIED>
<!ATTLIST DefaultGridProperties cellspacing
CDATA #IMPLIED>
<!--fill set to true means that the grid should
occupy all horizontal space in the layout->
<!ATTLIST DefaultGridProperties fill ( True |
False ) "True">
<!--pack set to true means that all but the last
grid cell in a row should take on the preferred
size of their contents CellElements-->
<!ATTLIST DefaultGridProperties pack ( True |
False ) "False">
<!--DefaultCellProperties define the default
attributes of all cells-->
<!ELEMENT DefaultCellProperties EMPTY>
<!ATTLIST DefaultCellProperties align ( Left |
Center | Right ) "Left">
<!ATTLIST DefaultCellProperties backgroundColor
CDATA #IMPLIED>
<!ATTLIST DefaultCellProperties valign ( Top |
Middle | Bottom ) "Middle">
<!ATTLIST DefaultCellProperties wrap ( True |
False ) "True" >
<!--Grid is a container for cells. A layout can
have multiple grid instances.-->
<!ELEMENT Grid (Cell+)>
<!ATTLIST Grid backgroundColor CDATA #IMPLIED>
<!ATTLIST Grid border CDATA #IMPLIED>
<!ATTLIST Grid cellpadding CDATA #IMPLIED>
<!ATTLIST Grid cellspacing CDATA #IMPLIED>
<!ATTLIST Grid fill ( True | False )>
<!ATTLIST Grid pack ( True | False )>
<!--
Cell contains the actual dashboard layout components
that the user sees and interacts with.
Cells are organized into a grid with the top left cell
being at x=0, y=0. A cell may span more than one row or
column by specifying a width or height > 1
-->
<!ELEMENT Cell ((Label | URLLink | ReportLink | QueryLink
| Chart | Image )*)>
<!ATTLIST Cell align ( Left | Center | Right )>
<!ATTLIST Cell backgroundColor CDATA #IMPLIED>
<!ATTLIST Cell height CDATA #IMPLIED>
<!ATTLIST Cell valign ( Top | Middle | Bottom )>
<!ATTLIST Cell width CDATA #IMPLIED>
<!ATTLIST Cell wrap ( True | False )>
<!ATTLIST Cell x CDATA #REQUIRED>
<!ATTLIST Cell y CDATA #REQUIRED>
<!--Label allows the designer to include descriptive text
in the dashboard layout. This text will wrap if the cell
attributes allow wrapping.-->
<!ELEMENT Label EMPTY>
<!ATTLIST Label text CDATA #IMPLIED>
<!ATTLIST Label textStyle idref #IMPLIED>
<!--URLLink allows the designer to include a link that will
launch a browser to the given hyperlink reference-->
<!ELEMENT URLLink EMPTY>
<!--href is the URL definition of the link (e.g.
http://www.ptc.com)-->
<!ATTLIST URLLink href CDATA #IMPLIED>
<!ATTLIST URLLink text CDATA #IMPLIED>
<!ATTLIST URLLink textStyle idref #IMPLIED>
<!--ReportLink allows the designer to include a link that
will launch a Windchill RVS Manager report.-->
<!ELEMENT ReportLink EMPTY>
<!--name is the fully qualified name of the report as
defined in the Windchill RVS Manager application-->
<!ATTLIST ReportLink name CDATA #IMPLIED>
<!ATTLIST ReportLink text CDATA #IMPLIED>
<!ATTLIST ReportLink textStyle idref #IMPLIED>
<!ATTLIST ReportLink filtered ( True | False )>
<!--QueryLink allows the designer to include a link that
will launch a Windchill RVS Manager items view against the
given query.-->
<!ELEMENT QueryLink EMPTY>
<!--name is the fully qualified name of the query as
defined in the Windchill RVS Manager application-->
<!ATTLIST QueryLink name CDATA #IMPLIED>
<!ATTLIST QueryLink text CDATA #IMPLIED>
<!ATTLIST QueryLink textStyle idref #IMPLIED>
<!ATTLIST QueryLink filtered ( True | False )>
<!--Chart allows the designer to include a
Windchill RVS Manager chart in the dashboard layout.-->
<!ELEMENT Chart EMPTY>
<!--name is the fully qualified name of the chart
as defined in the Windchill RVS Manager application-->
<!ATTLIST Chart name CDATA #IMPLIED>
<!--graphStyle allows the dashboard designer to override
the style of chart at run time. The default will be
whatever the chart designer requested.-->
<!ATTLIST Chart graphStyle ( VerticalBar | VerticalStackedBar
| HorizontalBar | HorizontalStackedBar | Pie | Line | Table )>
<!ATTLIST Chart height CDATA #IMPLIED>
<!ATTLIST Chart width CDATA #IMPLIED>
<!ATTLIST Chart filtered ( True | False )>
<!--Image allows the designer to include graphics in the
dashboard layout.-->
<!ELEMENT Image (ImageData)>
<!ATTLIST Image height CDATA #IMPLIED>
<!ATTLIST Image width CDATA #IMPLIED>
<!--ImageData is the element that actually contains the image
source. The source must be a base 64 (see
http://www.ietf.org/rfc/rfc2045.txt) encoded gif, jpg or png
image.-->
<!ELEMENT ImageData (#CDATA)>