HAI Use Case: View OLFS and BES logs

From OPeNDAP Documentation

Point Of Contact: Nathan Potter

1 Description

Provides Hyrax (OLFS and BES) log file access to Administrators.

2 Goal

By providing Hyrax log file access we enable the Admin to assess issues happening with a Hyrax instance. Once the log files have been viewed the Admin may choose to take additional actions via the HAI.

3 Summary

Once logged into the HAI the Admin selects a log to view. The HAI then shows the Admin the log file.

4 Actors

  • Administrator
  • HAI
  • Hyrax (OLFS & BES(s))

5 Preconditions

  • The Administrator has an authentication privileges for an HAI.

6 Triggers

For some reason the Admin wants to view the logs files generated by Hyrax.

7 Basic Flow

  1. The Admin logs into the HAI
  2. The Admin uses the HAI to choose to view logs files.
  3. The Admin uses the HAI to select which log file(s) to view.
  4. The HAI returns a page (or portion thereof) that contains scrollable views of the logs file(s).

8 Alternate Flow

Here we give any alternate flows that might occur. May include flows that involve error conditions. Or flows that fall outside of the basic flow.

9 Post Conditions

Here we give any conditions that will be true of the state of the system after the use case has been completed.

10 Activity Diagram

Here a diagram is given to show the flow of events that surrounds the use case.

11 Notes

There is always some piece of information that is required that has no other place to go. This is the place for that information.

12 Resources

In order to support the capabilities described in this Use Case, a set of resources must be available and/or configured. These resources include data and services, and the systems that offer them. This section will call out examples of these resources.

Resource Owner Description Availability Source System
name Organization that owns/ manages resource Short description of the resource How often the resource is available Name of system which provides resource