User Interface Requirements
- View System Status: The user will be able to see the current system status including the following:
- The zebrasrv status: The user will see if zebrasrv is running or not.
- The name of the last source to be harvested.
- The time and date of the last successful harvest.
- View System properties: The user will be able to see the system properties and property values stored in the h2qConfig.properties file.
- View H2Q Help: The user will be able to view help for each of the user actions.
- Add OAI Source: The user will be able to add an OAI Source for harvesting and indexing.
- Fields: The user will be able to enter the following:
- URL (required): The user will enter a url, select it from a list, or select a collection name that encapsulates a url.
- Set name (optional): The user can enter a set name, select if from a list, or select a collection name that encapsulates the set name.
- Output File Name(required): The user will enter an output file name to be used as the database name and name of folder containing the harvested xml files.
- How often(default: 1 day): The user can enter a value for frequency of harvesting. Valid numbers are integers greater than zero. Valid units are minutes, hours, days.
- Harvesting Enabled(default: yes): The user can specify if harvesting is enabled for the OAI source. A "yes" value means that the source will be harvested immediately after the user clicks "OK" and subsequently harvested according to the "How Often" (4.1.4) value. A "no" value means that the source will not be harvested until the user edits the source and changes the value to "yes".
- Actions: The user will be able to execute the following actions:
- OK: The system will validate the user input, create a new source object, schedule harvesting for that source, and index the zebra database after a successful harvest.
- Cancel: The system will confirm that the user wants to cancel the "Add OAI Source" task. If the user confirms, the system will close the task without saving or harvesting. If the user does not confirm, the system will return the user to the "Add OAI Source" task.
- Edit OAI Source: The user will be able to edit an existing OAI Source for harvesting and indexing.
- Editable Fields: The user will be able to edit the following:
- URL: The user may edit a url, select it from a list, or select a collection name that encapsulates a url. If the user changes the URL, the system will prompt the user to confirm that changing the URL will result in a full-harvest and the previous harvests from the previous URL will be deleted.
- Set name: The user may edit a set name, select if from a list, or select a collection name that encapsulates the set name. If the user changes the set name, the system will prompt the user to confirm that changing the set name will result in a full-harvest and the previous harvests from the previous set name will be deleted.
- How often: The user may edit the value for frequency of harvesting. Valid numbers are integers greater than zero. Valid units are minutes, hours, days.
- Harvesting Enabled(default: yes): The user can specify if harvesting is enabled for the OAI source. A "yes" value means that the source will be harvested immediately after the user clicks "OK" and subsequently harvested according to the "How Often" (5.1.3) value. A "no" value means that the source will not be harvested until the user edits the source and changes the value to "yes".
- Read-only fields
- Output File Name: The user will see the output file name that is used as the database name and name of folder containing the harvested xml files.
- First Created: The user will see the time and date that the source was first created in the H2Q system.
- Last Harvested: The user will see the time and date that the source was last successfully harvested.
- Actions: The user will be able to execute the following actions:
- OK: The system will validate the user input, edit the current source object, re-schedule harvesting for that source (for that source), and index the zebra database after a successful harvest.
- Cancel: The system will confirm that the user wants to cancel the "Add OAI Source" task. If the user confirms, the system will close the task without saving or harvesting. If the user does not confirm, the system will return the user to the "Edit OAI Source" task.
- List Sources: The user will view a list of OAI sources
- View Information: The user will see the following for each source:
- Status: The system will report harvesting and indexing status for each source. The system will track the number of times a harvest has failed for a particular source and reset the number upon a successful harvest.
- File Name: The user will see the given File Name for the OAI Source that will correspond with the database name and the folder name storing the harvested xml files.
- URL: The user will see the url for the given OAI source.
- Set: The user will see the set name for the given OAI source.
- Collection Name(optional): The user may see a collection name for the given OAI source.
- Last Updated: The user will see the date of the last user update to the given OAI source.
- Actions: For each source in the list, the user will be able to perform the following actions:
- Edit: The user can edit an OAI Source. See #2 Edit Source.
- Remove: The user can remove an OAI Source. The Source will be removed from the list and the system will delete the corresponding database tables and xml files.
- Integration with Ockham: The system will harvest Ockham and present the resulting OAI Collections to the user. The user may select a Collection or a URL & Set Name as a source to be harvested.
|
|