Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-43938

Usability/accessibility issues with feature to customize your site URL (alias)

    XMLWordPrintable

    Details

    • Test Plan:
      Hide
      1. On the test server, enable the following properties:
        • site-manage.enable.alias.new=true
        • site-manage.enable.alias.edit=true
      2. Log in as instructor.
      3. Go to Home, access the Worksite Setup tool, select Create New Site.
      4. Select to create Course Site, then Continue.
      5. Select a roster, Continue.
      6. Confirm there's an option to enter a site URL on the Edit Site Information page. Do not enter one, just Continue with default settings.
      7. Select both the Email Archive and Resources tools to add to the site, Continue.
      8. Copy the alias being created for the site email address to your computer clipboard (you can change it from the default first, if desired), Continue.
      9. On the Site Access screen, Continue.
      10. On the confirmation screen, Create Site.
      11. Access your newly created site, go to the Resources tool.
      12. Go to the Transfer Files tab, notice that the URL in Step 1 includes the alias created for Email Archive.
      13. Go to the Site Info tool.
        Actual behavior: The Site URL under the Site Information heading includes the site ID string.
        Expected behavior: The Site URL should include the alias that was already created for Email Archive (because it is, in fact, an alias associated with the site).
      14. Select the Edit Site Information tab.
      15. Actual behavior: The Add Site URL box is null. You can enter something there.
        Expected behavior: You have NOT yet granted the instructor the ability to add, edit, or delete Site URL in the site realms, therefore they should not be able to edit it or add a new alias for the URL at this time. The Site URL should show the alias that was already created for Email Archive (because it is, in fact, an alias associated with the site).
      16. In the null Add Site URL box, paste the alias that was used for Email Archive, then try to Continue.
      17. Actual behavior: You get an error saying the alias already exists (and thus, you can't use it).
        Expected behavior: If you're able to type in the box, you should be able to set the same alias for the site as you have already used for the Email Archive.
      18. Enter a different alias for the Site URL than the one used by Email Archive and Continue, then Finish.
      19. Go to the Resources tool.
      20. Go to the Transfer Files tab, notice that the URL in Step 1 now includes the new alias instead of the one previously created by Email Archive.
      21. Go to the Email Archive tool.
      22. Actual behavior: You now have multiple site email addresses!
      23. Make sure you still have the email alias copied to your computer clipboard. Go to the Options tab, delete the Site Email Address to null it out, Update Options.
      24. Expected behavior: You only have one address, that being the site alias.
      25. Go back to Site Info and Edit Site Information.
      26. In the Add Site URL box, enter the email alias you just removed and try to Continue.
      27. Actual behavior: You get an error saying the alias already exists (and thus, you can't use it).
        Expected behavior: Since you deleted the alias in the Email Archive, it should have been freed up for use.
      28. Log out as instructor. Log in as admin.
      29. Go to Administration Workspace and access the Aliases tool.
      30. Search for an alias currently associated with your site and copy the Site ID from the Target string (text that comes after /test/) to your computer clipboard.
      31. Go to the Realms tool in Administration Workspace.
      32. Search for the site ID you copied.
      33. Select the realm (it will be the link that does NOT include the word "group" or "content").
      34. Scroll down to the Roles section, select Instructor.
      35. Enable the following realm permissions for instructors:
        • alias.del
        • alias.upd
      36. At the bottom of the page, Save.
      37. Log out as admin, then log back in as instructor (I recommend fully logging out and back in rather than using Become User, as you might encounter realm caching issues resulting from the recent realm permissions change for the instructor role).
      38. Access your site where you created the aliases.
      39. Go to Site Info and Edit Site Information.
      40. Delete the alias from each Site URL field to null it out.
      41. Select Continue, then on the confirmation page, Finish.
      42. Actual behavior: You get an error that you don't have permission to delete the aliases.
        Expected behavior: Since you have alias.del permission in the site realm, you should be able to delete the aliases and save successfully.
      Show
      On the test server, enable the following properties: site-manage.enable.alias.new=true site-manage.enable.alias.edit=true Log in as instructor. Go to Home , access the Worksite Setup tool, select Create New Site . Select to create Course Site , then Continue . Select a roster, Continue . Confirm there's an option to enter a site URL on the Edit Site Information page. Do not enter one, just Continue with default settings. Select both the Email Archive and Resources tools to add to the site, Continue . Copy the alias being created for the site email address to your computer clipboard (you can change it from the default first, if desired), Continue . On the Site Access screen, Continue . On the confirmation screen, Create Site . Access your newly created site, go to the Resources tool. Go to the Transfer Files tab, notice that the URL in Step 1 includes the alias created for Email Archive . Go to the Site Info tool. Actual behavior: The Site URL under the Site Information heading includes the site ID string. Expected behavior: The Site URL should include the alias that was already created for Email Archive (because it is, in fact, an alias associated with the site). Select the Edit Site Information tab. Actual behavior: The Add Site URL box is null. You can enter something there. Expected behavior: You have NOT yet granted the instructor the ability to add, edit, or delete Site URL in the site realms, therefore they should not be able to edit it or add a new alias for the URL at this time. The Site URL should show the alias that was already created for Email Archive (because it is, in fact, an alias associated with the site). In the null Add Site URL box, paste the alias that was used for Email Archive , then try to Continue . Actual behavior: You get an error saying the alias already exists (and thus, you can't use it). Expected behavior: If you're able to type in the box, you should be able to set the same alias for the site as you have already used for the Email Archive . Enter a different alias for the Site URL than the one used by Email Archive and Continue , then Finish . Go to the Resources tool. Go to the Transfer Files tab, notice that the URL in Step 1 now includes the new alias instead of the one previously created by Email Archive. Go to the Email Archive tool. Actual behavior: You now have multiple site email addresses! Make sure you still have the email alias copied to your computer clipboard. Go to the Options tab, delete the Site Email Address to null it out, Update Options . Expected behavior: You only have one address, that being the site alias. Go back to Site Info and Edit Site Information . In the Add Site URL box, enter the email alias you just removed and try to Continue . Actual behavior: You get an error saying the alias already exists (and thus, you can't use it). Expected behavior: Since you deleted the alias in the Email Archive , it should have been freed up for use. Log out as instructor. Log in as admin. Go to Administration Workspace and access the Aliases tool. Search for an alias currently associated with your site and copy the Site ID from the Target string (text that comes after /test/) to your computer clipboard. Go to the Realms tool in Administration Workspace . Search for the site ID you copied. Select the realm (it will be the link that does NOT include the word "group" or "content"). Scroll down to the Roles section, select Instructor . Enable the following realm permissions for instructors: alias.del alias.upd At the bottom of the page, Save . Log out as admin, then log back in as instructor (I recommend fully logging out and back in rather than using Become User , as you might encounter realm caching issues resulting from the recent realm permissions change for the instructor role). Access your site where you created the aliases. Go to Site Info and Edit Site Information . Delete the alias from each Site URL field to null it out. Select Continue , then on the confirmation page, Finish . Actual behavior: You get an error that you don't have permission to delete the aliases. Expected behavior: Since you have alias.del permission in the site realm, you should be able to delete the aliases and save successfully.

      Description

      The feature for instructors/site maintainers to add a site alias would be useful to our users, but there are significant usability problems with it (listed below) that would need to be fixed before we can enable it. Some of the "Expected behaviors" I describe in the testing steps need to be reviewed by UX group, and possibly T&L. SAK-31874 (fixed) and SAK-39430 (not fixed) are intended to address a couple of these issues.

      Issues:

      1. Corresponding realm permissions do not behave as expected. When the property is enabled, instructors can add aliases regardless of whether they have the realm permissions needed to modify aliases in the site realm. They cannot delete aliases they add, even if they have the corresponding realm permission. I suspect site.upd, section.role.instructor or some other realm perm that inappropriately overrides other, finer-grained permissions is impacting this.
      2. Multiple aliases can be added to a site. This allows a single site/user to claim many aliases in the system, preventing them from being used by anyone else. In Email Archive, you can only create one address per site, so the same should be true of the Site URL. When multiple aliases are added, the most recently added one becomes the WebDAV URL for the site, and this could be confusing for users if they already set up a connection with another alias that is also associated with the site.
      3. Email Archive and Site URL aliases don't play nicely. The Email Archive alias and Site URL alias interact in unexpected ways, resulting in errors for users who are using Email Archive and also try to add a site alias (related to the issue mentioned above about multiple aliases per site).

      Desired behavior:

      • Only one alias should be created per site. If there is a use case for multiple aliases, you should be able, with a system property, to limit aliases to one per site.
      • The single alias should apply to all tools/items that use site aliases:
        • Site Info > Site URL
        • Email Archive
        • Resources > Transfer Files WebDAV URL
      • The same alias should display and be editable in both Email Archive and Site Info > Edit Site Information, and editing it in either place should change it in both.
      • You should be able to null out (delete) a Site URL alias you added just like you can delete an Email Archive alias, reverting the URL string to using the site ID.

        Gliffy Diagrams

          Zeplin

            Attachments

              Activity

                People

                Assignee:
                a.fish@lancaster.ac.uk Adrian Fish
                Reporter:
                rainribbon Tiffany Stull
                Votes:
                1 Vote for this issue
                Watchers:
                4 Start watching this issue

                  Dates

                  Created:
                  Updated:

                    Git Integration