Inserting Component Types

Overview

Teaching: 30 min
Exercises: 0 min

Questions

• Architect privilage is required.

• How do I newly create Components (only available with the WEB UI)?

Objectives

• Users with the Architect privilege should be able to insert new Component Types.

Contents

	Description
A requirement and preparation
Know what you want to insert!
Inserting manually
Inserting a spreadsheet

A requirement and preparation

This page is to teach a user how to insert new Component Types into the DUNE HWDB. Only users with the Architect privilege are allowed to do so. If you don’t have such privilege, you likely do not go through the contents on this page. If you think you should know how to, but don’t have the Architect privilege, please contact the DUNE database group.

Let’s check if your account in the HWDB already has the Architect privilege. From the side-menu of the HWDB, go to Users and find your own account. If you have the Architect privilege, you should have a check-mark under architect as shown below.

back to top

Know what you want to insert!

Just to remind you, the figure below shows the DUNE PID syntax. Remember that with a combination of Project, System ID, Subsystem ID, Component Type ID, and Item Number, every DUNE component in the HWDB is uniquely defined. And the Item Number is just a counter. Thus, for each of the Component Types you like to like newly create, you should have the followings prepared:

• Project (usually “D”)
• System ID and the corresponding System Name
• Subsystem ID and the corresponding Subsystem Name
• Component Type ID and the corresponding Component Type Name

There are two ways to do this. In either way, you will do these through your web browser.

1. Do it manually, one-by-one.
2. Do it by providing a prepared spreadsheet.

back to top

Inserting manually

As an example, let’s insert the following new Component Type:

• Project = D
• System ID = 005
• System Name = FD1-HD HVS
• Subsystem ID = 998
• Subsystem Name = HWDBUnitTest
• Component Type ID = 00011
• Component Type Name = Test Type 011

This Subsystem (ID = 998, name = HWDBUnitTest) already exists in the HWDB. Let’s find it.

From the side-menu, go to Admin and then click Projects as shown below.

You now should be seeing a list of Project as shown below. Click the Systems folder (DUNE), which takes you to the list of Systems.

In the list of Systems, click the Subsystems folder (FD1-HD HVS) as shown below.

You should be seeing a list of Subsystems as shown below. Select the Subsystems folder (HWDBUnitTest) now.

The figure below shows a list of the Component Types that are currently available in the HWDB for the selected Subsystem, HWDBTestUnit.

Click “ADD NEW TYPE…”.

You now should be seeing a figure similar to the one shown below. Enter:

• Type Name
• Type ID
• Comments (optional)

and then click “SAVE”.

After saving, you should be seeing a screen like the one below.

If you now go back to the list of Component Types, you should be seeing a figure like the one shown below.

In the above example, our Subsystem ID has been already defined in the HWDB. In general, you could newly defined Subsystem ID as well. The procedure would be entirely identical to what we just described above, except that you ADD new Subsystem ID to a list of Subsystems instead.

back to top

Inserting a spreadsheet

Now let’s insert multiple new Component Types at once.

Prepare a spreadsheet similar to the one shown below.

You could have multiple different System IDs and multiple different Subsystem IDs in general. In this example, for simplicity, we stick with the same System ID and Subsystem ID as before.

Cautions: For those names (not IDs) entered in your sheet, you cannot use the following characters: comma, period, quotation marks, underscore or the percent sign.

From the side-menu, go to Admin and then select Upload Excel as shown below.

Drag & drop your prepared Excel sheet there.

Once you drop your sheet there, screen like below should show up. Your requested System ID(s) is checked to see if it is in the accepted format.

If looks OK, click “NEXT”.

Similarly it checks your requested Subsystem ID(s) as shown below. Again, if it looks OK, click “NEXT” to proceed.

And finally it checks your requested Component Type ID(s). Make sure they look OK before clicking “SAVE” to finalize the creation process. Once they are saved, you will not be able to delete them!

When everything goes well, you should be notified by a message like the one shown below. Notice that no Systems and Subsystems were newly created, while 9 Component Types have been created.

Finally, if you go back to the list of the Component Types like the one shown below, newly created Component Types should be showing up there.

back to top

Key Points

• Only users with the Architect privilege are allowed to add new Componnet Types.

• Two ways to do this, either manually by one-by-one or with a prepared spreadsheet.