Nomad++ Domain Messaging Module

Modified on Wed, 17 Jan 2024 at 03:38 PM

Domain messaging is a powerful component of LibKey Nomad++ allowing the administrator to setup custom messages, links, and authentication loops across any domain on the internet.  This can be used for a wide variety of purposes such as:

  • Providing a mechanism to automatically authenticate users when they arrive at a library resource unauthenticated
  • Provide a message to highlight specific information about a resource at a domain (for example, instructions to contact library staff for a username/password or noting that a particular resource is under trial)
  • Creating a custom link to route users in an appropriate direction (for example, bringing them from the New York Times website to ProQuest where the newspapers may be accessed in full text)
  • Linking users to an appropriate LibGuide to learn more about how to use a particular resource
  • Create a link and message to encourage users to fill out a survey about a resource
  • And more!

This accomplished through a series of Rules that are created by library administrators.  The Domain Messaging Module consists of both a List of Rules and Rule Edit pages for each Rule that appears within the List of Rules.


List of Rules:

The list of rules shows all currently programmed rules at a particular library.  When rules are created they are automatically made active and will appear for users within one hour.  Administrators (and anyone else who would like to) can shorten that time to seconds by clicking on the Manual Refresh LibKey Nomad Configuration button within the Settings area of the LibKey Nomad browser extension.


The sort order for the list of rules is by default set to "last updated" so that the most recently updated rules appear at the top.


Using the Search box you can easily filter the list down by rule name or URL.


You can also sort the rules by every column and this sort can be combined with the search.


You can unselect rules in the Active column (make sure you click the "Save" button which will appear green after you do this!) to turn off a given rule without deleting it.


Clicking on the trash can icon in the far right of the row will allow you to permanently delete the rule.


The three icon columns (message, link, authentication loop) are provided as a quick reminder of what components of the rule exist for a particular rule.



Rule Edit Page:

The Rule edit page contains sophisticated options for creating and editing rules to achieve a wide variety of effects.


The Rules are divided into three distinct sections, separated by a horizontal rule in the interface, that can be describe thus:


Rule Name

- Consists of a single box to name the rule whatever you like.  This should be descriptive as it appears in the List of Rules page and is searchable.


Parameters affecting when a rule is executed

These three boxes are all strung together with internal "AND" logic.  That is, all three of these conditional elements must be TRUE for the rule to take effect on a given web page.


- Domain

        This is the domain you would like the rule to have an effect on.  Domains only are allowed here (i.e. "publisher.com").   Subdomains are included automatically (i.e. "www.publisher.com") so they do not need to be specified.  If you would like to make a rule to call out a SPECIFIC subdomain (i.e. "database.publisher.com") you can do this and the domain with the most matching characters will win out.


        So, if you have both "publisher.com" and "database.publisher.com" in LibKey Nomad and the user arrives at "database.publisher.com" -- it will be the "database.publisher.com" rule that will be followed but if they simply go to "publisher.com" then it will be the "publisher.com" rule followed instead.


- Content Link Consideration

       This field allows you different combinations of consideration for whether LibKey can present a link to content (article or ebook) for a particular page.  These have names including "Download PDF", "Article Link", "View E-Book", "View Manuscript".  "Access Options" is not considered a "content link" because it is unlikely to directly forward to content and instead will forward to a system so that a user may request a piece of content via ILL/Document Delivery.


This powerful feature means it is unnecessary to create separate rules for every domain as LibKey technology already covers over 800 domains across the scholarly publishing world allowing rules to be focussed on addressing unique situations that may exist.  This following combinations of availability for content to decide if a rule should be executed are as follows:

            - Display rule when content link is not present

            - Display rule in addition to content link

            - Display rule in addition and regardless of content link

            - Display rule in place of a content link


- Authentication Consideration

        This field allows you to limit the appearance of a rule based on whether the user is currently authenticated to a particular domain.  This is most useful when paired with the "Authentication Loop" type of message to help get users authenticated (and then not bug them again to authenticate once they are!)  The following options are:

           - User is not authenticated to this domain

           - User is authenticated to this domain

           - User is or is not authenticated to this domain

The mechanism that determines HOW this happens is complex and involves different mechanisms for different types of authentication between IP, VPN, Proxy and OpenAthens.  Generally speaking however, IP based services (IP/VPN/Proxy) will be a combination of URL analysis and user IP checks against a library's pre-configured IP ranges done with Third Iron Support and OpenAthens employs a timer approach to ensure that if a user has requested to authenticate the message does not appear for another 55 minutes (typically safely within the limits of sessions).


Parameters affecting what is displayed for the user

If all the parameters affecting WHEN the rule is executed match, then this section outlines what is displayed for the user.


- Message

    This is a free text space (including emojis if you would like!) which allows you to communicate a message to a user.  Really long messages will automatically be line wrapped when displayed.  This field is optional.  For example, you could have a rule that has now message but instead provides an Authentication Loop Link.


- Link Type

     Messages may optionally include a link.  The default toggle is "No Link" but the other options are:

    

    - Authentication Loop: This will provide a link that automatically applies authentication to the page the user is currently viewing.  Clicking the link then should bring the user to the authentication point and back to the existing page upon successful authentication.  Configuration of this authentication prefix is shared with general BrowZine/LibKey configuration information already known by Third Iron.  A Link Text is required with this option.


   - Custom: A custom link is just as it sounds - you can specify any link in the "Link URL" field (required) and specify custom text (required) to go with it.  This is great for leading users away from one domain and bringing them to another.


Once any modifications to a rule are made the grey "SAVED" button will turn to a green "SAVE" button prompting you to click this to save and then return back to the Rule List to continue editing or creating additional rules.