DUNE HWDB Training: HWDB Dashboard

This page describes usage of the HWDB Dashboard which provides data obtained from the HWDB visually (e.g., by plotting them).

Contents

Section	Description
Overview/Browse	Allows one to go through the component hierarchy with ease
Type View	Displays a summary of a selected Component Type
Item View	Displays a summary of a selected Item
Detector	Allows one to explore Component Type hierarchy charts
Shipments	Displays statuses of available shipping boxes
Activities	Displays recent changes in the HWDB

What is this:

This is a web-based app, lets you;

• go through the hierarchical structure of the HWDB (Systems, Subsystems, Types, and Items) easily,
• help you to deal with your shipments (e.g., packing, shipping, and tracking them),
• generate and post Executive Summaries,
• and interact with component type heretical charts.

Access from here: https://www.phy.bnl.gov/twister/cets/hw/.

And anybody with FNAL SSO credential should be able to access.
After loggin, you would likely see a screen like the one shown below:

As can be seen there:

• It allows you to access to two versions of the HWDB, the production or the development.
• At the top, we have the tabbed navigation. There are currently 6 selections. For the rest of this page, we go through each of these tabs and describe their basic functionalities and their usages.

More detail description can be also found here: https://github.com/BNLIF/cets/blob/main/docs/tutorial/hwdb-explorer.md.

Overview/Browse:

As the two tabs provide very similar functionality, we describe only Overview here.
As can be seen below, one can go up/down through the component hierarchy, starting from Projects (through Systems, Subsystems) to Types.

In the example screenshot below, we see:

• Project = DUNE (D)
  • Region = Far Detector
    • Family = Far Detector
      • System = FD CE (System ID = 081)
        • Subsystem = FEMB (Subsystem ID = 011)
          • Type = FD-VD MiniSAS (Component Type ID = D08101100041)

It also indicates how many Items in each layer. For instance, we see there are currently 28 Items (PIDs) under Type ID = D08101100041.

For those dimmed ones (not solid black) indicate either there are no Items (PIDs) created or they are not synced to the HWDB, yet.

Clicking a particular Type here would take you to the Type View.

back to top

Type View:

Once a particular Type is selected, you would see a Type View as shown below.
It shows:

• Summary of this Type (Name, ID, # of Items.. etc).
• Histogram of Items under this Type as a function of date.
  Optionally one can overlay distributions with additional conditions on flags (status, uploaded, certified, and installed).
• Histograms of Tests (all available Test Types under this Type).
• Paginated list of available PIDs under this Type.

Selecting a particular PID here will take you to its Item View in a new tab.

back to top

Item View:

It provides information about the Item:

• PID.
• Country, institution, and manufacturer.
• Component status.
• QA/QC Uploaded (binary flag).
• Certified QA/QC (binary flag).
• Installed (binary flag).
• Serial Number.
• Item Specifications.
• Tests (data are downloadable in JSON).
• The latest available Executive Summary and a link to edit it or newly post one.
• Timeline of its location.
• PIDs of linked sub-components.
• Binaries (photos, csv files) that are associated with this PID.

back to top

Detector:

It shows a Component Type hierarchy chart (for the vertical drift version only for now).

A Component Type hierarchy chart shows Component Types, that actually exist in the HWDB. Each box in the chart represents a Component Type (or sometimes multiple Component Types). And these Component Types could be generic Types, but also cables as well. Background colors of these boxes correspond to each of the responsible consortia.

Boxes are connected by arrows. Color of the arrows could be either black, that is for connections between generic Type, or red, that is for connections between a generic Type and cable Type.
The direction of the arrows always point from a child to its parent.

The original charts can be found here:

• HD: https://edms.cern.ch/document/3467007/
• VD: https://edms.cern.ch/document/3416341/

One can go up/down/right/left and zoom-in/out with your mouse.
As can be seen below, clicking one of the boxes would pop up a small window, in which info about the Component Type, along with a link to the Type, is displayed.

back to top

Shipments

In the Shipments tab, it shows the currently available shipping boxes/containers (PIDs) as can be seen below:

(for details of how to deal with shipments using the Dashboard, please refer to DUNE Shipping Procedure)

You see all available shipping containers/boxes (PIDs) here, separately for the ones that are;

• currently in In-Transit status,
• have some contents in them, but not shipped, yet,
• and the ones that are completely empty (no linked sub-components).

Type in your Type ID or name and find your shipping box (a PID). Select a PID and start to pack!

Selecting a particular PID would take you to its shipping box View like the one below.
There, you can see:

• Info about the shipping box (status, flags).
• Tests, if any.
• Contents of the 2 checklists, Pre-shipping and Shipping.
  You can also directly download the corresponding Shipping Sheet (the label with bar/QR-codes).
• Info from the SD Warehouse if available.
• A link to an existing Executive Summary if already exists, or to newly create or edit one.
• A list of linked sub-components (the actual contents of this shipping box).
• Location timeline of this shipping box.
• Binaries (such as photos) that are associated with this shipping box, if any.

back to top

Activities

This shows "what have been changed in the HWDB" when the sync process of the HWDB finds anything new (e.g., new Items, new Test records… etc). An example screenshot is shown below:

You can also get notified about changes for specific Component Types or Items.
For instance, in a Type View, you would find a Watch button at the top-right as shown below. Click it to include that Type to your Watch List. You can take the same stem in a Item View to watch a specific Item.

To remove from your Watch List, click your user profile avatar, which takes you to a page as shown below.
You can remove Types and/or Items from yoru Watch List here.

back to top