Configuration
10
3.2.1. Formal definition of the object model
The object model has a formal definition in the form of an XML Schema Document (XSD) file, which is
itself an XML file, normally intended for machine-processing. A more readable version of this information is
available in Appendix H.
Note, however, that this is reference material, containing only brief descriptions, and intended for users who
are familiar with the product, and in particular, for users configuring their units primarily via XML.
The XSD file is also available on the software downloads website by following the "XSD" link that is present
against each software release.
3.2.2. Common attributes
Most objects have a
comment
attribute which is free-form text that can be used for any purpose. Similarly,
most objects have a
source
attribute that is intended for use by automated configuration management tools.
Neither of these attributes have a direct effect on the operation of the FB6000.
Many objects have a
name
attribute which is non optional and often needs to be unique within the list of object.
This allows the named object to be referenced from other attributes. The data type for these is typically an
NMTOKEN which is a variant of a string type that does not allow spaces. If you include spaces then they are
removed automatically. This helps avoid any problems referencing names in other places especially where the
reference may be a space separated list.
Many objects have a
graph
attribute. This allows a graph name to be specified. However, the actual graph
name will be normalised to avoide spaces and limit the number of characters. Try to keep graph names as basic
characters (letters, numbers) to avoid confusion.
3.3. Configuration Methods
The configuration objects are created and manipulated by the user via one of two configuration methods :
• web-based graphical User Interface accessed using a supported web-browser
• an XML (eXtensible Markup Language) file representing the entire object hierarchy, editable via the web
interface or can be uploaded to the FB6000
The two methods operate on the same underlying object model, and so it is possible to readily move between
the two methods - changes made via the User Interface will be visible as changes to the XML, and vice-versa.
Users may choose to start out using the User Interface, and - as experience with the object model and the XML
language develops - increasingly make changes in the XML environment. For information on using XML to
configure the FB6000, please refer to Section 3.5.
3.4. Web User Interface Overview
This section provides an overview of how to use the web-based User Interface. We recommend that you
read this section if you are unfamiliar with the FB6000, so that you feel comfortable with the design of the
User Interface. Later chapters cover specific functionality topics, describing which objects are relevant, any
underlying operational principles that are useful to understand, and what effect the attributes (and their values)
have.
The web-based User Interface provides a method to create the objects that control operation of the FB6000.
Internally, the User Interface uses a formal definition of the object model to determine where (in the hierarchy)
objects may be created, and what attributes may exist on each object, so you can expect the User Interface to
always generate valid XML.
1
1
If the User Interface does not generate valid XML - i.e. when saving changes to the configuration the FireBrick reports XML errors, then this
may be a bug - please check this via the appropriate support channel(s).
