Tech Blog

For Institutions: Setting up a real-time acquisitions workflow with participating vendors

Real Time Acquisition General Overview
Instructions for Institutions
Instructions for vendors
General overview of ExLibris APIs methodology
Related blogs

This article contains the required steps for institutions, in order to set up a real-time acquisitions workflow with participating vendors. For general description of the real-time acquisitions workflow, see here.

Note: This article is general, for setting the workflow with any vendor. You can find here specific instructions for setting the workflow with ProQuest Coutts OASIS.

Set-up for Real Time Ordering happens both on the vendor and the Alma side.

Configuration in Alma

Information you will need to send the vendor

Troubleshooting

After the above information was supplied to the vendor, we recommend that the following will be done in order to make sure the integration is set properly:
  1. Perform GET /almaws/v1/acq/test?apikey={supplied apikey}
The response should be in the following form:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<test>GET - OK - institutionCode: 01MY_INST</test>
Make sure that the institution is the correct one. If not – it means that the API key was not generated using the institution account.

 

  1. Perform POST/almaws/v1/acq/test?apikey={supplied apikey}
The response should be in the following form:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<test>POST - OK</test>
If 400 HTTP error was retrieved, it means that the API key was not defined with read/write permission, or it is against a demo environment.
  1. “Failed to create bibliographic record” error message
Make sure that the institution has defined a default metadata template (Open metadata editor – template – choose the one you want to define as a default – click properties – check as default). In Addition, make sure that this template has definition for LDR and 245 fields (it might contain other fields as well).
  1. “Failed to create the PO Line. Errors: N/A” error message
If the payload includes locations structure, make sure that the quantity field is not empty:
<locations>
 <location>
   <quantity></quantity>
   <library>MAIN</library>
   <shelving_location>LOCATION1</shelving_location>
 </location>
</locations>

 

Using real time acquisitions with multiple vendors

Multiple vendors can use real time acquisitions in one institution.
Vendor A and Vendor B be given separate API keys, each allowing acquisitions APIs.
Each institution can set up multiple API keys – see Generating API keys.
Note that the same new order API integration profile is used by all cases of orders being created via the new order API, received from any vendor. See How the BIB record is determined for more details.

 

6 Replies to “For Institutions: Setting up a real-time acquisitions workflow with participating vendors”

  1. on this page https://developers.exlibrisgroup.com/blog/Real-time-Acquisitions-setup-for-institutions/

    there is a dead link where a page has been removed.
    Where it says “2. New Order API Integration Profile: Decide about the matching rules that you want to apply – see How the bibliographic record is determined. Validations for fund related issue can also be configured as documented here (docx).”
    the link for here (docx) has been removed, so it’s not very helpful.

  2. Are the screenshots for this current? I tried following the instructions in the article but it appears the layout for the developers network has changed and, as a result, I’m not sure they are accurate anymore.

  3. Under Troubleshooting, item number 3 states:

    “Failed to create bibliographic record” error message
    Make sure that the institution has defined a default metadata template (Open metadata editor – template – choose the one you want to define as a default – click properties – check as default). In Addition, make sure that this template has definition for LDR and 245 fields.

    Does this mean that the default template should only contain an LDR and 245 field? If not, is there a reference to what the template should contain?
    Thanks!

  4. Hi Theodore,
    The default template should include at least LDR and 245. It might contain other fields as well.

    I edited the post – hope it is more clear now.

    Thanks,
    Tamar

Leave a Reply