HAI Use Case: View OLFS and BES logs: Difference between revisions

Revision as of 17:28, 8 November 2010

Point Of Contact: Nathan Potter

Description

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

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.

Summary

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

Actors

Administrator
HAI
Hyrax
BES

Preconditions

The Administrator has an authentication privileges for an HAI.

Triggers

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

Basic Flow

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

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.

Post Conditions

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

Activity Diagram

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

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.

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

@@ Line 1: / Line 1: @@
-'''Point Of Contact:''' ''A Human''
+'''Point Of Contact:''' ''[[User:ndp | Nathan Potter]]''
 == Description ==
-<font size="-2" color="green">''Give a short descriptive name for the use case to serve as a unique identifier.''</font>
+Provides Hyrax (OLFS and BES)  log file access to Administrators.
 == Goal ==
-<font size="-2" color="green">''The goal briefly describes what the user intends to achieve with this use case.''</font>
+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.
 == Summary ==
-<font size="-2" color="green">''Give a summary of the use case to capture the essence of the use case (no longer than a page). It provides a quick overview and includes the goal and principal actor.''</font>
+Once logged into the HAI the Admin selects a log to view. The HAI then shows the Admin the log file.
 == Actors ==
-<font size="-2" color="green">''List actors, people or things outside the system that either acts on the system (primary actors) or is acted on by the system (secondary actors). Primary actors are ones that invoke the use case and benefit from the result. Identify sensors, models, portals and relevant data resources. Identify the primary actor and briefly describe role.''</font>
+* Administrator
+* HAI
+* Hyrax
+* BES
 == Preconditions ==
-<font size="-2" color="green">''Here we state any assumptions about the state of the system that must be met for the trigger (below) to initiate the use case. Any assumptions about other systems can also be stated here, for example, weather conditions. List all preconditions.''</font>
+* The Administrator has an authentication privileges for an HAI.
 == Triggers ==
-<font size="-2" color="green">''Here we describe in detail the event or events that brings about the execution of this use case. Triggers can be external, temporal, or internal. They can be single events or when a set of conditions are met, List all triggers and relationships.''</font>
+For some reason the Admin wants to view the logs files generated by Hyrax.
 == Basic Flow ==
-<font size="-2" color="green">''Often referred to as the primary scenario or course of events. In the basic flow we describe the flow that would be followed if the use case where to follow its main plot from start to end. Error states or alternate states that might be highlighted are not included here. This gives any browser of the document a quick view of how the system will work. Here the flow can be documented as a list, a conversation or as a story.(as much as required)''</font>
+# [[HAI_Use_Case:_Administrator_Logs_into_the_Hyrax_Admin_Interface  | The Admin logs into the HAI]]
+# The Admin uses the HAI to choose to view logs files.
+# The Admin uses the HAI to select which log file(s) to view.
+# The HAI returns a page (or portion thereof) that contains scrollable views of the logs file(s).
 == Alternate Flow ==