Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 3.39 KB

admin-view.md

File metadata and controls

69 lines (42 loc) · 3.39 KB

Admin View

Digital Paper Edit (DPE) has an Admin View, that can only be accessed if you have "ADMIN" access. What this essentially means is that you have the power to view all the progress of transcripts and add users in DPE.

Why

One of the challenges with debugging the problems with the transcripts is the unique identifiers (UUID's) assigned to every document (similar to an item in a database) in a collection (similar to a table in a database). For example, when you create a new user, it will create a new document with UUID: wehfauighaiwjoj12356. It's difficult to tell which is what, who owns what, and who is who. This dashboard allows you to join up the information in a meaningful way, that helps to quickly identify the necessary information to debug an issue.

Features

You can access via selecting your email address. E.g. in the image below, access the Admin view by clicking [email protected]. Access Admin View

Transcripts View

Transcripts View

You can view the following fields in the Transcripts View

Status Message Created Updated Transcript ID Transcript Title Project ID Project Title Transcription Duration (Dhms) Duration (Hms) Size (bytes) File location Media Type

Note

The Message is only useful for when the Status is either in-progress or fail or error. E.g. the Message may say "Transcribing..." but the Status may say done. This indicates that the transcription is actually complete. This is because once the transcription is updated, the message does not get updated. We treat the Status to take precedence over the Message

Debug with ease

By clicking on the transcript ID link - here it is ytt..., it will take you to the Firebase Functions Console with the search term prepopulated with the transcript ID. This will help to search and debug the problematic transcript faster.

  1. Select ID Select transcript ID to debug
  2. Go to Firebase's Function Console to find the problem Firebase Console

Users View

Admin Users View

You can view the following fields in the Users View

User ID Email Project ID Project Title Project Created Role Updated Access

Add User

You can also add a user via the User View. See the doc for that.

Technical: Verifying Admin Access

Firestore

In the users Collections of Digital Paper Edit, if your user document's role is ADMIN, then you have Admin powers.

Firestore Security Rules

Firestore Security Rules also determine whether a user can read or write on the database.

UI

In the Admin Component, you should see a line that determines whether you can access the admin view by a button:

   {user && user.role === 'ADMIN' ? <a href="#admin">{authUser.email}</a> : authUser.email}