Wayfinder can be embedded into your site if you are using OpenAthens Keystone. Which is kinda cool.
*.yourdomain.com
) The code is tied to the specific Keystone application since Wayfinder needs to know where to return the user. If you need to support multiple apps from a common login page you will need to find a way to insert the relevant oaAppId (coloured red in the interface).
wayfinder-login
selector in the trigger - e.g:<a href="javascript:;" class="wayfinder-login">Institutional login</a>
wayfinder
selector, e.g:<div id="wayfinder">Loading...</div>
You should not set a height on the div or search results may overflow the available space.
If neither selector is found on the page, no error is displayed to the user but one is sent to the console. If both are on the page then the wayfinder
selector will be used (embedded).
It's up to you of course, but we would suggest that where your login function is in a small area of a regular page then the overlay is probably the better choice as searching for organisations can produce several answers. If your login function is on a dedicated page then the div version may fit in better with the UX and style. Both will allow you to customise the labels - see the advanced options section below.
When testing, try some terms that will produce many results (such as University) and use the show more results button.
The OpenAthens federation will be updated automatically but if you are in any other federations they will have to update your metadata to include valid discovery return URLs before Wayfinder can work for you:
<idpdisc:DiscoveryResponse Binding="urn:oasis:names:tc:SAML:profiles:SSO:idp-discovery-protocol" Location="http://connect.openathens.net/saml/2/auth" index="1"/> |
Some advanced information for anyone who needs a little more control
Logic flow_wayfinder.optionsThese allow some changes of behaviour - add them to the end of the script bock you got from the dashboard - e.g:
The options currently available are:
More options may become available in the future. About GeolocationGeolocation can help users select the correct organisation when none are shown, but means the browser will ask for permission when it hits any page with the Wayfinder javascript in the head. If Wayfinder will appear on multiple pages we recommend leaving this function disabled. About rememberCrossSiteThe default and recommended mode is to allow the organisation selection a user made elsewhere using Wayfinder to be reflected in your instance (and also the organisation selection made in your instance available elsewhere). This provides the best user experience, however you can turn it off with this option if you need to limit it to just remembering choices on your site - e.g. if the users commonly need to use a different IdP to access your site. Customising the appearanceRetaining the default appearance of the embedded Wayfinder is encouraged as this provides a consistent user experience across sites (one of its goals). If you must change the appearance (such as when the colours clash with your brand), then you can override the styles for some key classes in your CSS. Here is an example: Overlay button The overlay version is invoked by a button which has three possible appearances and uses the
(The
|