-
Notifications
You must be signed in to change notification settings - Fork 381
Add support for LinkIQ OpenURL resolver. #5009
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Conversation
|
@cwolfebsco Could you take a look at this? This is now done as far as I can tell, but I couldn't find examples of embargos, so that part may still need tweaking if it's not taking all options into account. |
cwolfebsco
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much for working on this and for providing support for LinkIQ. I am very grateful for the detailed work shown here.
Personally, I would trust others significantly more than myself to consider the PR from a code point of view, so I've only provided comments relating to LinkIQ functionality.
I would suggest to consider a change to the logic on what link display text to pull out and use linkText from the EBSCO response, as a preferential value, as both linkName & packageName might be sub-optimal.
config/vufind/config.ini
Outdated
| ; Additional resolver settings required for EBSCO LinkIQ (available with | ||
| ; Full Text Finder). | ||
| [LinkIQ] | ||
| ; Password for the service: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It can be quite confusing to figure out what password is needed - within EBSCO the password is known as the Profile Password and I would thus suggest using this for this comment.
| continue; | ||
| } | ||
| $result = [ | ||
| 'title' => ($link['packageInfo']['packageName'] ?? null) ?: ($link['linkName'] ?? ''), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not certain that this picks the most relevant link text for display to the user.
$link['packageInfo']['packageName']
- would be something like Academic Search Complete. Sometimes package names contain additional details to help differentiate them in the admin tool, e.g. Springer Nature Hybrid, Subscription and Fully OA (BIBSAM). This information is valuable for an administrator, but might be confusing to end-users
$link['linkName']
- would be a customer set value designed to help differentiate links in the admin tool, the name might not be very meaningful, nor might it be user friendly, but it might be helpful for administration. An example (though not common) might be Get It Now (New Interface - FTF)
$link['linkText']
- this was created by the administrator to reflect the link in Full Text Finder menu as a user facing link text. It is a required field in FTF link administration.
Links that are returned in LinkIQ are set both on whether they were assigned to holdings (some link will always show), and based on mandatory fields, which determine the minimum amount of available metadata.
Considering the above I would like to suggest $link['linkText'] as the default for the title attribute, as it can be controlled by the library and has the least chance of containing administrator facing additions, which would be confusing the end-users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the explanation! I've revised the code. I also refactored it so that it's easier to customize in downstream code if someone wishes so.
|
@cwolfebsco, can you clarify the product portfolio/branding here? Is LinkIQ a separate product from Full Text Finder, or an add-on, or an API within it? (I'm just trying to determine whether it's feasible for us to test this at Villanova, as I'm not sure if we have access to the product; the name "LinkIQ" doesn't seem to show up very often). |
The OpenURL Resolver is Full Text Finder, the API is called LinkIQ. I can ping you on Slack after my next meeting to get you your Profile Password |
Thanks, @cwolfebsco, that's all very helpful! @EreMaijala, maybe you should clarify this in the documentation. I see that you do already mention this above the [LinkIQ] section, but maybe we should also be more explicit in the list of resolver types to help people know what options are available to them. |
|
@demiankatz I revised the comments. If you think that there's still room for improvement, please feel free to suggest changes. :) As I don't have experience on the admin side I could still be misunderstanding stuff. |
While EDS searches probably already display relevant links, this can be useful for linking from local catalog records and records from other sources not included in EDS.