Admin-set collections are displayed private while visibility is set public

[jmfrenzel]

Descriptive summary

Collections are displayed private https://nurax-dev.curationexperts.com/dashboard/collections?utf8=%E2%9C%93&locale=en&q=Hyrax+v3.0.0beta
while visibility is set public https://nurax-dev.curationexperts.com/admin/admin_sets/c534fp06m/edit?locale=en#visibility

Don't mind the broken thumbnails https://nurax-dev.curationexperts.com/dashboard/collections?utf8=%E2%9C%93&locale=en&q=Hyrax+v3.0.0beta

Rationale

Expected behavior

For admin-set collections visibility column in collection listing should display the actual visibility setting of that collection.

Actual behavior

For admin-set collections visibility column in collection listing displays private irrespective of actual
visibility setting of that collection.

Steps to reproduce the behavior

1. create admin set collection
2. public visibility (default)
3. compare visibility at https://nurax-dev.curationexperts.com/dashboard/my/collections?locale=en

Related work

Link to related tickets or prior related work here.

[kdid]

@no-reply @vantuyls - I need some feedback on how this should behave.

So, for collections (all types except Admin Sets), that permission badge (in the visibility column) is showing the collections's visibility: "These settings determine who is able to discover and view this collection's landing page; they do not affect the visibility of items in the collection."

Admin Sets do not seem to contain an equivalent visibility setting (visibility on the AdminSet itself appears to always be 'restricted'). I was thinking this was as simple as showing the visibility setting on the associated PermissionTemplate - and this does work as far as showing "Private", "Institution" or "Public" in the badge - but it looks like Permission templates can have nil visibility (and from looking at the code - maybe even other values.) Also, that visibility setting is not related to the discovery of the Admin Set itself like it is for Collections: "Release and visibility settings determine the options available to depositors when submitting a work to this administrative set. Changes to these settings do not affect previously deposited works."

What do you think is the "correct" behavior here. Maybe it is correct that "Private" is showing for all Admin Sets? Or should that permission badge not be shown at all for admin sets? Or just not shown if it's something other than Public, Institution, or Private? Or... ?

[vantuyls]

@kdid are you saying that Admin Set type Collections do not behave re: visibility in the same way as other collections?

@elrayle can you speak to the initial design behind this? is this expected behavior or unexpected? do we always expect an Admin Set to be of Restricted visibility?

[julesies]

not sure about the design, but I agree with @kdid that confusion is when Visibility "badge" in this "collection index" is to display the visibility/discoverability of the collection object itself, not the works in the collection and admin sets are not allowed to be visible.

I agree that having no badge for admin sets listed in the collection index view is confusing/feels buggy!

[julesies]

@kdid I updated my original comment b/c i realized I was restating what you already said. Sorry about that! comment edited.

[kdid]

Just to clarify in case it's not clear in the initial issue - Right now Admin Sets always display with a "Private" badge.

[vantuyls]

if admin sets are not discoverable then Private is a fine label.

[kdid]

After discussion yesterday with @no-reply @chrisdaaz and @vantuyls we came to a consensus that we should leave this functionality as is for now. AdminSets are not discoverable, which is what the permission badge in the visibility column is indicating for Collections. We know that this leaves a confusing situation in the UI, but think the work to change this should be undertaken in conjunction with the remaining work to actually make AdminSets a type of Collection. Returning this issue to backlog.

[vantuyls]

on SIGAHR call today, we discussed that one solution to help clarify this would be to add a third tab to the Collections dashboard page that only shows Admin Sets, and prevent Admin Sets from appearing in other collection tabs.

More discussion is welcome.

[julesies]

Just adding this comment from slack:
one complication is that Collections Types could be set up so those collections of that type are not discoverable so that view (if split) could have the same issue
so i think i would vote for making new badge or greying out the “private” badge to cover both use cases?

[elrayle]

The visibility marker in the UI on the Collections page is the visibility of the collection/admin set itself. It does not reflect the visibility setting that will be used for newly created works.

Terminology for Collection Type Settings

Container - Instance of the Admin Set collection type or any other collection type

VISIBILITY - Controls visibility of works -- Determines if visibility of works created in this container can be controlled by further settings on the container itself. (Currently limited to the Admin Set collection type.)

DISCOVERABILTY - Controls visibility of container -- Determine if the container itself can be discovered through search by non-logged in users. (Currently the Admin Set collection type can NOT have discovery turned on.)

Collection

Example Collection Type settings for non-admin set collection type (e.g. User Collection)

These settings can vary except that the last 3 will never be selected for a non-admin set collection type.

VISIBILITY

Can never be turned on for non-admin set collection type. Non-admin set collection types NEVER have the Release and Visibility tab on the Edit Collection form.

DISCOVERY

This can be checked or not checked for any non-admin set collection type.

When checked, any collections of this type will have a Discovery tab in the Edit Collection form. The user can set the visibility of the collection itself to Public, Institution, or Private. This effects whether a non-logged in user can discover this collection in search. It does NOT impact the discoverability of any works in the collection.

When NOT checked, any collection of this type will be Private. The Discovery tab will NOT be visible in the Edit Collection form. Non-logged in users will not be able to discover or view this collection.

Admin Set

Collection Type settings for the Admin Set collection type

VISIBILITY

This setting is always ON for every Admin Set. The Release and Visibility tab is visible on the Edit Collection form for a specific Admin Set collection. The settings on that tab control options a user has when creating a work in that Admin Set.

DISCOVERY

This setting is always OFF for every Admin Set. The Discovery tab is NOT shown on teh Edit Collection form for any Admin Set. All Admin Sets are PRIVATE. Non-logged in users will not be able to discover or view any Admin Set collection.

I notice an error in these settings on nurax. DISCOVERY is shown as checked and SHOULD NOT be checked. You cannot set the discovery of an admin set. All admin sets are PRIVATE, meaning the admin set itself cannot be discovered. In spite of this setting, all admin sets continue to be private. I thought this bug was fixed.

[elrayle]

For this specific issue... the badge indicates whether the collection/admin set itself is discoverable.

For admin sets, the visibility of the admin set itself is always PRIVATE and so the badge always = PRIVATE.

For non-admin_set collections, it may be forced to be PRIVATE (if DISCOVERY for it's collection type is OFF), or the collection admin may be able to set it to PRIVATE, PUBLIC, or INSTITUTION (when DISCOVERY for it's collection type is ON).

The summary in the list of collections at dashboard/collections says nothing about the settings on the Release and Visibility tab.

[elrayle]

Seems like labeling confusion. Collection Level Visibility would be more descriptive. But that would make the label very long.

[elrayle]

Related Documentation:

• Understanding Collections Types
• Collection Discovery FAQ

[rjkati]

@jlhardes looks like this one needs a decision and perhaps documentation.

[jlhardes]

From what I can tell, there are several things going on here.

1. I think the initial issue report is equating Admin Sets with Collections and they are not equivalent. Admin users (and not just users who can log in and create Collections) are the only ones who can create Admin Sets.
2. Admin users are also the only users who can create Collection Types. The Visibility checkbox setting in Collection Types is, again, only something that can be encountered by Admin users creating a new collection type and not just any user who can log in and create Collections. This Visibility checkbox also only applies to Admin Sets in certain conditions and I have yet to figure out how to make that happen. Even when creating a new Admin Set as an Admin user I cannot check Require Membership, Workflow, or Visibility - those checkboxes are disabled (this is in my local Docker build).
3. For users who can log in and create Collections, the Visibility of Collection badge (which shows for anything listed in Collections, including Admin Sets) is possibly being misinterpreted as visibility of the collection and everything inside of it. From what I can tell, that Visibility of Collection badge literally only refers to the landing page of the collection. Work visibility still dictates whether or not a work is visible. If a user is not logged in at all, this is the experience: If the collection is private but the work is public, the collection landing page is not available but the work can still be found and viewed. If the collection is public and the work is private, the collection landing page can be viewed but the work does not show on the collection landing page and the work cannot be found and viewed.
4. Admin Sets are never going to have public landing pages so that Visibility of Collection badge is always going to be set to Private for an Admin Set.
5. On Works, the Visibility of Work badge actually links into the Work edit form to the Sharing tab where you can see and change the Visibility of the Work. The Visibility of Collection badge does not link anywhere. If it were to link to the Discovery tab of the Collection edit form, that provides options to change visibility and an explanation that this only effects the landing page visibility of the collection and not the works within. For Admin Sets, the Private badge could link to the Release and Visibility tab of the Admin Set edit form, although nothing in here will change that badge. The Visibility portion of the Admin Set tab could use more explanation and possibly a link to the appropriate section of the KB (maybe https://samvera.github.io/admin-sets-as-collections-faq.html). If this seems useful, this work would be a new issue.
6. I think we need to sort out the documentation needed to properly explain what is up with Admin Sets for Admin users for this issue. I think I would want to do the work in Point 5 first since that might clarify what documentation updates would be helpful for Admin Sets.

Sorry for such a long list of things but this is a part of the application that is easily confusing. If I am mistaken on any of those points above, please let me know.

[jlhardes]

Proceed with documentation updates to explain Visibility portion of Admin Set tab. Any development changes will be a new issue.

[rjkati]

samvera/samvera.github.io#436 addresses this ticket. See last paragraph under the section "Creating an Administrative Set".

[jlhardes]

Documentation explaining admin sets and visibility settings in Hyrax 3.x available at https://samvera.github.io/administrative-sets-3.x.html