Skip to end of metadata
Go to start of metadata

Overview of "Troubleshoot Deployed Instrument" Use Case

Diagnose deployed platform and instrument faults.

Tip: Key Points
UC Priority= 4 or 5: Critical, is in R2
Only boldface steps are required
<#> before a step —> lower priority
(optional) —> run-time option

Related Jira Issues:   Open   •   All


Refer to the Product Description and Product Description Release 2 pages for metadata definitions.

Actors Observatory Operator, Integrated Observatory Operator
Uses UC.R2.14 Monitor an Instrument
UC.R2.10 Manage Marine Platform
UC.R2.04 Browse to Get Data Product
Is Used By  
Is Extended By  
In Acceptance Scenarios AS.R2.01A Operate Marine Observatory, AS.R2.02B Data Support via Cruise, AS.R2.02C Instrument Life Cycle Support
Technical Notes  
Lead Team S&A
Primary Service Marine Observatory Facility Services
Version 1.6.2
UC Priority 4
UC Status Mapped + Ready
UX Exposure ONC


This information summarizes the Use Case functionality.

Use tools and procedures to diagnose and fix deployed instrument malfunctions.


  • Only information which is forwarded to terrestrial network can be monitored. (Higher priority messages should be forwarded first.)

Initial State

Instrument has been integrated into remote platform, has been running normally for some time

Scenario for "Troubleshoot Deployed Instrument" Use Case

  1. Data process in Integrated Observatory generates event based on instrument engineering parameter's value.
    1. This may be a value like 'Battery Voltage' outside acceptable limits, or a status value like 'Calibration Status' no longer reading "OK".
    2. Specific values to test will be specified by marine observatories before and during operations.
  2. <3> Marine Observatory Operator asynchronously receives event message(s) indicating instrument fault(s)
    1. Fault message utility is also referenced by UC.R2.10 Manage Marine Platform use case
    2. Likely because operator was subscribed by default to all messages of this type.
    3. Promotion of event message to an alert is described in UC.R2.14 Monitor an Instrument use case.
  3. Operator retrieves faulty instrument's transmitted data products (science and engineering), inspects and analyzes retrieved data and messages
    1. So far this is just looking at the data already retrieved.
  4. Operator views current instrument status, gets list of latest messages
    1. Goes back and looks at/searches through past messages looking for clues and patterns.
    2. Possibly message have not been transferred to shore yet, but we have to assume this is not the case.
  5. <2> Operator configures agent/driver to emit debug messages
    1. Agents/drivers should emit messages at operator-specified level/verbosity, e.g. error/warn/info/debug (the coding terms). Normally agents/drivers would operate in low-verbosity (non-debug) mode.
    2. Operator needs to subscribe to these messages or configure the system to log them.
  6. <3> Observatory Operator configures alert and notification system to alert when a certain message is received.
  7. Operator logs onto remote platform to examine settings and conditions
    1. Capabilities here depend on the platform in question and the communication link.
  8. <3> Observatory Operator configures remote platform and/or communication system to connect and communicate messages more often.
    1. This setting will be 'undone' when troubleshooting is through.
  9. <2> Operator inspects and analyzes debug messages
  10. Operator accesses instrument in "direct mode", tests communication and response from instrument
    1. See UC.R2.07 Direct Instrument Access use case.

Final State

All reasonable paths to identify and address the instrument failure have been addressed.


These comments provide additional context (usually quite technical) for editors of the use case.

(click on # to go to R2 use case)
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
61     27B


r2-usecase r2-usecase Delete
usecase usecase Delete
productdescription productdescription Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.