Skip to main content
Version: 2.0

Projects

In WeConfig, a project refers to a collection of items representing an observed network. A project can be saved to the file system, and uses the .nprj (Network project) extension by default when saved. The actual file itself is a ZIP-archive and can be opened/inspected using software like 7z.

Contents​

A project file contains the following information:

  • A network specification
  • A data directory containing
    • Cached user notifications and their state.
    • Project-wide attachments
    • A device-attachments directory containing
  • A configuration file directory containing
    • A subdirectory per device that has backups containing
      • any backups associated with the device

Network specification​

The network specification, called Project.xml within the project file, is an XML-file that details the topology of the network, along with any properties attached to the device. This XML file has some specific properties of note:

Project version​

The first element of the XML-File looks roughly as follows

<Project Version="3.1" xmlns="http://westermo.com/weconfig">

Take note of the version attribute, which is metadata for WeConfig that states which version of the project structure is in use. WeConfig 2.0 writes version 3.1, but can read both 3.0 (used by WeConfig 1.21) and 3.1.

Physical Network​

Under the <PhysicalNetwork> element, two primary sub-elements exists, <Nodes> and <Connections>. Nodes contains the set of devices present in the network, and Connections contains a connection map of how the different devices are linked together.

Device element​

Under the <Nodes> element, several <Device> elements are usually found. This element is a serialization of WeConfigs knowledge of the device, and contains information including, but not limited to:

  • Model
  • Firmware version
  • Management IP Address
  • Mac Address
  • Ports
  • VLAN
  • Routes
  • And more...

There also usually exists a special element under <Nodes> called the <WeConfigPC> node, this corresponds to the computer running WeConfig that discovered the devices.

Connection element​

Under the <Connections> element, a variety of connection elements exist, these tend to be one of:

  • <AggregatePortConnection>: indicating a n-to-n port connection between devices where all ports involved are known.
  • <WeConfigConnection>: indicating a 1-to-1 port connection between devices where at least 1 port involved is unknown.
  • <RoutedConnection>: indicating a 1-to-1 connection between devices where neither port is known, typically as a result of being discovered via tracing routes.

Together, these connection elements span all known connections between devices.

Attachments​

Attachments are generic files that have been associated either with the project itself or with a specific device. They can be of any file type and with any content. For more details, see Attachments and Device Attachments.

Backups​

A backup is a copy of a devices configuration file at a certain date and time, possibly with some attached metadata used by WeConfig. For more information, see Backups