Skip to content
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

Adds Terms tool code into Coral #488

Merged
merged 13 commits into from
Feb 16, 2020
Merged

Conversation

queryluke
Copy link
Contributor

@queryluke queryluke commented Sep 22, 2018

To test

  1. Navigate to the licensing module and click on Admin
  2. At the bottom of the page, there is a new setting for the terms tool which allows you to choose a service (SerialsSolutions, SFX, or EBSCO).
  3. After selecting the service, enter the required variables for your service.

Setting up a license

(skip this if you already have licenses & resources made)

  1. In the Resources Module, create a new resource (it should have an ISBN or ISSN)
  2. In the Licensing Module, create a new license
  3. Select the new license, and "upload a new document" (you can provide any values but do not select Archived, you may upload any document)
  4. On the license page, select Expressions on the left and "add new expression", for Expression Type you need to select a type that is setup for terms tool display. Interlibrary Loan and Course Packs is setup by default. To make a new one (or edit and existing one), you may do so in the Admin utility. Either add or update an expression type with a Note type of "Display." To get the check mark or X mark to show up in the terms tool, you also need to setup qualifiers of either Permitted or Prohibited for the expression (in the admin tool)
  5. After adding an expression to the license, you must also check beside the expression name:

screen shot 2018-09-22 at 1 59 22 pm

You may optionally add a display note.
  1. On the license page, select Terms Tool and "add new terms tool resource link"

  2. Choose your document and enter the resource. Note: the string entered in Resource must exactly match the string returned from the Terms Tool Service.

screen shot 2018-09-22 at 2 06 42 pm

For example, I am using the EBSCO service, so the name must match the package name that the resource comes from. In the above example that name is "Academic Search Complete"

Test that the terms tool works

To test the resource, provide the resource's ISxN to the terms tool route:
http://your.coral.domain/licensing/terms.php?issn=xxxx-xxxx
or
http://your.coral.domain/licensing/terms.php?isbn=xxxxxxxxxxxxx

Here is an example output
screen shot 2018-09-22 at 2 13 01 pm

Note about terms route

You may notice there is a change to the terms tool route. In older versions of coral it used to be /terms?issn=xxxx-xxxx. But users may have there older version of terms tool installed in this directory. So instead, I created a new file in the licensing module and moved the necessary files. Thus, any installation that upgrades their code base won't have an issue with conflicting files.

Terms tool CSS [edit: 2020/02/15]

Per the request of Sirsidynix, I've added their updated css for the terms two. The base styles are found in licensing/css/base-terms.css. If a site would like to update the colors or adjust the css, they can do so by creating a licensing/css/custom.css file.

@jeffnm jeffnm added enhancement This is an enhancement (not a bug) help wanted good first issue Good first issue for beginners. Welcome ! labels Apr 29, 2019
@andyp-uk
Copy link
Contributor

Have tested this on several systems in house and appears to be working as intended with EBSCO HoldingsIQ.

@andyp-uk andyp-uk merged commit 3b145f3 into coral-erm:development Feb 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is an enhancement (not a bug) good first issue Good first issue for beginners. Welcome ! help wanted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants