This is an old revision of the document!


Admin Tools

The Admin Tools page will provide an administrator with the tools they need to manage the Ancient Graffiti Project's data. An administrator account (these will be the only accounts, but could they possibly have different permissions?), will be able to update their own passwords, add an editor, remove an editor, see all current editor accounts, edit graffiti, update EpiDocs, generate reports for all graffiti, export all graffiti as an EpiDoc file, add words to the blacklist, remove words from the blacklist, and see all words currently blacklisted. Before a user can have access to all of these features, they must first sign-in as an administrator. This is done through a login screen, where the user must supply a valid username and password. New accounts should not be created at this phase. Only current administrators should have the authority to add accounts. This will protect the integrity of the data on the site. Once the admin is logged in, they will be taken to an editing hub. Here they will find links to the pages where they can exercise their various permissions, neatly and properly organized of course. Each of these features respective pages will need to be designed and implemented, though it should be mentioned that preliminary versions of many already exist.

Feature Description

Prerequisites

For Use

  • The user must first navigate to the admin login portal (something for which there is not currently a link)
  • The user must have a valid username and password, which they remember
  • The users session must not have timed-out.

For Implementation

  • An understanding of the various admin tools and their functionalities
  • An understanding of the EpiDoc
    • How does it work?
    • What does the existing EpiDoc function look like?
    • Is their anything we need to change?
  • An understanding of the blacklist and the index
    • What does the blacklist look like?
    • What qualifies as a blacklist item?
    • What data structures will best suit our needs?

What the User Sees

The Admin should see a window asking for a login name and a password at login (maybe a Reset Password option?). Once the admin logs in successfully, they should see a list of tools laid out clearly on the page, with each tool linking to a new page that has the corresponding admin functionality. The EpiDoc functionality should be implemented in the specific graffiti selection, allowing highlighting abilities. Besides, the user should be able to save the EpiDoc in the case of uploading new data. The blacklist index, which should have similar functionality to the actual index, should use the same structure as the actual index. We will communicate closely with the Index team to make sure they match. Besides, the website should be able to check if the items entered qualified as blacklist items.

User Behavior

While the administrator will have all of the functionality that a regular user does, they will have additional functionality to fit their needs. What the administrators are doing on the page might be slightly different than a typical user. First and foremost, an administrator might perform any of the activities listed when they first log in: Edit a Graffito, Generate a Report for all Graffiti, Download all Graffiti as an Epidoc, Change their Password, Add a new Editor, and/or Remove an Editor. When viewing any Graffito, an administrator can edit that Graffito. When viewing all of the graffiti, an admin can generate a report.

Use Cases

The use cases of the various features are listed within the individual features.

Relative Priority

While the Admin Tools might not be the top priority on this project, it still has fairly high priority as administrators will need to access functionality of the site that typical visitors of the site are unable to. In terms of priority of the individual Admin Tools features, the priority is as follows, from high priority to low priority:

  • High: Generate Reports for All Graffiti, Export all Graffiti Data as Epidoc
  • Medium: Managing Editors, Password Changes, Edit Graffiti and EpiDocify Content
  • Low: Blacklist and Group Words for the Index

More in-depth descriptions about the prioritization of each feature can be seen within the individual feature's page.

courses/cs335/spring2019/graffiti/admin.1556634727.txt.gz · Last modified: 2019/04/30 14:32 by cohene
CC Attribution-Noncommercial-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0