Bug 1794346 - Change the label for the flashing eye icon during user impersonation
Summary: Change the label for the flashing eye icon during user impersonation
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Users & Roles
Version: 6.7.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: 6.8.0
Assignee: Ondřej Pražák
QA Contact: Peter Ondrejka
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-01-23 11:01 UTC by Vlada Grosu
Modified: 2020-10-27 13:00 UTC (History)
3 users (show)

Fixed In Version: foreman-2.0.0
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-10-27 13:00:04 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
aria-describedby (187.17 KB, image/png)
2020-01-28 09:18 UTC, Ondřej Pražák
no flags Details
fa-eye (3.87 KB, image/png)
2020-01-31 09:27 UTC, Ondřej Pražák
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 28895 0 Normal Closed Improve message on impersonation session start 2020-10-28 17:23:09 UTC
Red Hat Product Errata RHSA-2020:4366 0 None None None 2020-10-27 13:00:17 UTC

Description Vlada Grosu 2020-01-23 11:01:02 UTC
Description of problem:
During an impersonation session, in the upper right of the main menu, there is a flashing eye icon that signals to the user that they are currently engaged in an impersonation session.
This is not a problem and is in fact a good visual cue to the user.
However, I think there is an issue with the embedded assistance for this icon (UI element). 

A. When a user starts an impersonation session the following notification is displayed:
"You impersonated user Richard Wright, to cancel the session, click the eye icon in the top bar."

I think the problem is 'the eye icon' -> seems like an odd choice for an icon label. It is too colloquial; if the feature name is impersonation then the icon that visually represents that feature should be called something that relates to the feature, for example 'Impersonation'. 

B. Once an impersonating session is in progress, if one hovers over the flashing eye icon the following hover help text is displayed:

"You are impersonating another user, click to stop the impersonation".

This is even more ambiguous as the control-level assistance avoids a direct reference to the icon label.
From an accessibility point of view, what happens when a screen reader is used, are the hover help texts read by the screen reader? (I don't know the answer to this, so hoping you can help.) 


Without a clear icon label, it is difficult to reference this UI element in the product documentation.

Is it possible to rename the icon from 'eye icon' to 'Impersonation icon' for example, or any other name that you think correctly represents the feature?

Thank you in advance.


Version-Release number of selected component (if applicable):
6.7 Beta


How reproducible:
Always reproducible.


Steps to Reproduce:
1. In to the Satellite web UI, navigate to Administer > Users.
2. To the right of the user that you want to impersonate, from the list in the Acions column, select Impersonate.
3. To cancel the impersonation session, in the upper right of the main menu, click the flashing eye icon.

Actual results:
Please see the Description of Problem field.


Expected results: 
Would like to get a clarification on the icon label for the impersonation feature.


Additional info:
BZ#1778825 (docs bug to create docs for the new feature)

Comment 5 Ondřej Pražák 2020-01-28 09:18:16 UTC
Created attachment 1655915 [details]
aria-describedby

Comment 6 Ondřej Pražák 2020-01-28 09:19:13 UTC
Thank you for bringing up these very interesting points!

A) label for the impersonation/eye icon
The intent behind using 'eye icon' is to visually describe the icon in the top bar and make it obvious that 'eye icon' stands for impersonation in the same way the 'bell icon' stands for notifications.
If we change 'eye icon' to 'impersonation icon', I can imagine users asking: "Ok, which one is impersonation icon?" as there is no established association between impersonation feature and the icon that visually looks like eye.

I think the key here is to establish a link between the impersonation feature and its graphical representation - the eye icon. Maybe we can expand the message a bit, something like: "...to cancel the session, click the yellow blinking eye icon in the top bar representing active impersonation session."
What do you think?

B) tooltip text of the icon
In what way is it ambiguous that the tooltip text does not reference the icon? The tooltip is displayed on hover, so the cursor will be positioned on the icon when the text is displayed. In that situation user needs to "click to stop the impersonation". Do you have any suggestions on what test the tooltip should contain?


The icon has aria-describedby attribute, so there should not be a problem with accessibility.

Comment 7 Vlada Grosu 2020-01-29 17:34:20 UTC
Hi Ondrej,

Thank you for looking into this. 

A. To use the same example, when describing the Notifications button we don't mention the bell icon, but we refer to it by its label 'Notifications'. For example, we say "To view Satellite event notification alerts, click the Notifications icon in the upper right of the screen."

For the impersonation feature there is a description of the new functionality 'impersonation', an eye icon with the label 'eye icon' and no logical connection between the name of the label and the function of the UI element. I would argue that this is possibly just as confusing for the user as in the case where they would be wondering "Ok, which one is impersonation icon?".

Another thought worth considering: how does the 'eye icon' fair with regard to localization? Depending on cultural differences an eye symbol (or word) could potentially mean different things and have various connotations. I honestly don't know. I would prefer not to use such labels in product docs for that reason.


I have an idea how to work around this. I found the following topic in the Admin guide: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.6/html-single/administering_red_hat_satellite/index?lb_target=production#form-Red_Hat_Satellite-Administering_Red_Hat_Satellite-Navigation_Tabs_in_the_Satellite_Web_UI

We can add an image of the Impersonation icon (to anticipate a user's need for more information) to the existing table and explain what it represents, similar to the bell icon -> Notifications situation.
In this case the only thing you would need to do is edit the notification message that is displayed when an impersonation session is started:
"You impersonated user Richard Wright, to cancel the session, click the eye icon in the top bar." s/eye/Impersonation 

B. Thank you for explaining that, it's great that a screen reader would pick up on that text! Thanks for that.

What I personally found ambiguous was that the statement doesn't explicitly call out the icon by its label, while the notification message at the start of an impersonation session does. Which is perfectly fine on its own. To be honest, I prefer it that way. I was trying to use this example as an argument against using the 'eye icon'. Apologies for not being clear enough.
TLDR - no actions required on your behalf :)

Please let me know what you think. Also, do let me know if you would prefer to discuss this over a call, I'd be up for that as well.

Many thanks!

Comment 8 Ondřej Pražák 2020-01-30 07:47:52 UTC
I think you have found a solution for A.

* add an image of Impersonation icon to the table in Admin guide
* change the notification message: s/eye/Impersonation/

Thank you!

Comment 9 Ondřej Pražák 2020-01-30 07:50:16 UTC
Created redmine issue https://projects.theforeman.org/issues/28895 from this bug

Comment 10 Bryan Kearney 2020-01-30 09:04:09 UTC
Upstream bug assigned to oprazak

Comment 11 Bryan Kearney 2020-01-30 09:04:12 UTC
Upstream bug assigned to oprazak

Comment 12 Vlada Grosu 2020-01-30 10:14:20 UTC
Hi Ondrej,

Can you please attach the icon image that I could use for the Admin Guide?
I presume you have a suitable format, superior to the quality I would get from a screenshot. :-)

Many thanks,
Vlada

Comment 13 Bryan Kearney 2020-01-30 13:03:55 UTC
Moving this bug to POST for triage into Satellite 6 since the upstream issue https://projects.theforeman.org/issues/28895 has been resolved.

Comment 14 Ondřej Pražák 2020-01-31 09:27:50 UTC
Created attachment 1656684 [details]
fa-eye

I hope this fits your needs.

Comment 20 errata-xmlrpc 2020-10-27 13:00:04 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Important: Satellite 6.8 release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2020:4366


Note You need to log in before you can comment on or make changes to this bug.