MHK ISDB/Help

Jump to: navigation, search

Help & Documentation

Search for a Device

Use the Search page to search for devices. A basic search can be performed by entering a device name or keyword into the search bar found at the top of the page. An advanced search can be performed by selecting facets under the View Devices By section.

Add a Device

To add a device to the database:

  1. Click the button in the Menu bar
  2. Select the appropriate link from the menu options, either Add Instrument or Add Sensor
  3. Enter the device name. Click the Add/Edit button to open the form
  4. Complete the web form
  5. Save

Users must be logged in to edit the database.

Edit a Device

To edit an existing device in the database:

  1. Navigate to the device page using the search options
  2. On the device page, click the Edit with form button, just above the MHK Instrumentation & Sensor Database menu bar
  3. Edit the desired field(s)
  4. Save

OR

  1. Click the button in the Menu bar
  2. Select the appropriate link from the menu options, either Add Instrument or Add Sensor
  3. Enter the existing device's name (it must match the existing name EXACTLY). Click the Add/Edit button to open the form
  4. Edit the desired field(s)
  5. Save

Users must be logged in to edit the database.

Undo an Edit

To undo an edit:

  1. On the device page, click the 'History button, just above the MHK Instrumentation & Sensor Database menu bar
  2. Find the edit(s) in the list
  3. Use the compare revisions option if needed
  4. Click the undo option to the right of the desired revision
  5. Save

Adding Images

Device images are displayed on pages by referencing an online image. Image files are not saved to the MHK Instrumentation Database, but the URL path to the online image is saved.

To add an image to a device page:

  1. Find an online image of the device
  2. Copy the full URL for the image (it should include http://)
  3. Add a new Instrument or Sensor OR edit an existing device
  4. Enter the URL from above in the Instrument Image or Sensor Image field
  5. Upload
Example: http://www.aanderaa.com/media/products/3D-smartguard.jpg

Assign Sensors to an Instrument

Instruments inherit their measurement properties from the sensors assigned to them. Sensors can be assigned to instruments using the Instrument form. To ensure the sensors are assigned correctly, it is recommended to add all sensors to the database before adding a new instrument. However, any instrument can be edited at any time to add sensors.

  1. Add a new Instrument OR edit an existing device
  2. Enter the sensor name in the Sensor(s) field
  • This field uses autocomplete to suggest sensors as a user types
  • Sensors added to the database using the Sensor form will begin with MHK_ISDB/Sensor/ , start typing this to bring up a list of all sensors in the database
  • Use a semicolon to separate multiple sensors
  • If a sensor does not autocomplete, please be sure it exists in the database and spell check its name

Track Changes

Pages in the MHK Instrumentation & Sensor Database can be tracked for changes. Users may be interested in knowing if devices they have added are edited by other users, the Watch option will allow them to track the page and its edits.

From any wiki page:
  1. Hover over or click Page Actions in the OpenEI top menu
  2. Select the Watch option
  3. The page is added to the user's watchlist
To learn more about tracking changes, visit the Help:Tracking changes page.

Refresh a Page

OpenEI and the MHK Instrumentation & Sensor Database contain pages that have many semantic relationships. This means that if a page is edited, it is possible that it may take several minutes or more for the changes to appear on pages using those semantic relationships.

The Refresh option will help to expedite the update for the semantic relationships on a page.

From any wiki page:
  1. Hover over or click Page Actions in the OpenEI top menu
  2. Select the Refresh option
Example 1
If an instrument uses multiple sensors, those sensor measurements are inherited by the instrument. If one of the sensor's measurement properties are updated, it may take a few minutes for those changes to be passed along to the instrument that inherits the sensor's measurement properties. In this case, use Refresh on the instrument page to update it.
Example 2
A new device has been added to the database, but is not yet showing up in the search results on the Search page. In this case, use Refresh on the Search page to update the query results.

Move a Page

In the wiki, moving a page is the method used to rename the page. Device names cannot be edited using the Edit with form option, the field is restricted to admin users. This is to ensure that the move method is used to rename pages.

From any wiki page:
  1. Hover over or click Page Actions in the OpenEI top menu
  2. Select the Move option
  3. Enter the new name in second field after To new title:
    BE SURE TO LEAVE MHK ISDB/Sensors/ or MHK ISDB/Instruments/ INTACT! Only change the name after the last /
  4. Click the Move page button
MHK ISDB/Sensors/ and MHK ISDB/Instruments/ are essential to making the device page exclusive to the MHK Instrumentation & Sensor Database. Without this in the name, the page would be moved, but may not work as intended in the database, or may not show up in search results.
To learn more about moving pages in the wiki, visit Help:Moving a page.

Definitions

A definitions page has been created for the MHK Instrumentation & Sensor Database, which displays definitions that are specifically related to MHK technology and this database. This page queries the OpenEI glossary for definitions and terms that are part of MHK Instrumentation & Sensor Database.

To add new definitions to the glossary:

Definitions added using the method below will automatically be included in both the OpenEI Glossary and the MHK Instrumentation & Sensor Database definitions pages
  1. Visit the MHK Instrumentation & Sensor Database definitions page
  2. Click Add a MHK Definition and enter the term
  3. Complete the web form
  4. Save

To add an existing definition to the MHK definitions page:

If a definition already exists in the OpenEI Glossary, is related to MHK, but is not displaying in the MHK Instrumentation & Sensor Database definitions page, use the following instructions:
  1. Navigate to the definition page from the OpenEI Glossary
  2. Hover over or click Page Actions in the OpenEI top menu
  3. Click the Edit option
  4. Place your cursor before the closing template brackets }} in the edit window
  5. Add the following to the page code
|Category=MHK Instrumentation & Sensor Database
  1. Save

Update Measurement Properties

For DB Administrators
There is a help page for updating measurement properties related to the MHK Instrumentation & Sensor Database. The Measurement Properties Help page includes documentation and architecture for the measurement properties.

This includes:

  • how allowed values are set, added or removed
  • how to add or remove properties
  • how to update the values displayed in the web forms and search facets.

This procedures are for advanced users with administrative access only.

Update Improper Property Values

For DB Administrators
From time to time, devices may be saved with improper property values. When a property value is not allowed, a warning indicator will appear on the page where the error occurred, it looks like a small yellow triangle with an exclamation point inside of it. Hovering over the indicator will display a pop up message stating what the error is. Usually, this is a spelling or grammar error or a missing delimiter. Sometimes, it is because a value that is not part of the allowed values list for that property has been saved. Repair of these errors should be addressed on a device by device basis.

There is a help page with a list of all pages with an improper value: Improper Property Values Help.