-
Notifications
You must be signed in to change notification settings - Fork 1
Admin Functionality
This page describes admin dashboard options and admin mailer functionality.
Admin Users have two additional 'TASKS' on the dashboard sidebar compared to a vanilla Hyrax 2.0.0 application.
- Manage Registered Users
- Approve Pending Users
Administrators can update user information and approve users that have registered. Once an administrator approves, the user's information is used to automatically create a Person entry within Fedora.
Administrators can update user information and sync the updated registration with the Person information in Fedora.
To update the user's information, click on 'Update Registration', edit fields as necessary, and click 'Update.
To synchronize the user's information in Fedora, click on 'Sync Person'
Registration information is stored within the application's DB (currently sqlite3). Person information is stored within Fedora. By updating registration, the current functionality of the application is to only update the application's DB record for the user. In order to synchronize the DB information with Fedora, the administrator needs to click on 'Sync Person', which will use the user information to update the Person information in Fedora.
In the future, this should be more seamless, and the "Sync Person" functionality should automatically be performed after updating registration. However, it is not currently this way. It was easier to test functionality as separate options while developing the prototype, and that's why it is this way.
Also, in the future, it would be good to implement functionality that will delete a user. This will need to be worked out more, as it's not clear what should happen to Person information once a person has been removed from the VDC.
There is an AdminMailer class that is responsible for all of the emails that are currently being sent out to administrators and users by the system.
https://github.com/dibbs-vdc/ccql/blob/v0.3/app/mailers/admin_mailer.rb
Currently, emails are sent out to the administrators and users by the system in the following cases:
-
new_user_waiting_for_approval- After a potential user has registered, and an email is sent to that user to inform the user that approval is pending. -
new_user_waiting_for_approval_admin_notification- After a potential user has registered, an email is sent out to the administrators to inform them that there is a new user awaiting approval from an administrator. -
new_user_approval- After an administrator has granted approval to a pending user, an email is sent to the user to inform him/her that the registration has been approved. -
updated_person_admin_notification- After an administrator has updated Person information within Fedora, an email is sent out to the administrators indicating that an update has occurred.
Currently, the administrator email list is set via the environment variable ADMIN_MAILER_DEFAULT_FROM. (See https://github.com/dibbs-vdc/ccql/blob/v0.3/config/admin_mailer.yml) It would be more beneficial to change this to generate an administrator email list automatically, based on different roles. However, we currently don't have different admin roles set up (future enhancement). Eventually, if we had a role specifically for approving users, it would be nice to have the admin email list generated from the users with that role.