Building a LibX Edition for Primo

As of yesterday, we’re a Primo library. So for the last couple of days we’ve been working to change all the things that need changing after you get a new catalog. One librarian is doing most of the work to change all of our links to our old catalog or items in the catalog in all of our LibGuides. Meanwhile, I took on trying to get LibX to recognize our new catalog.

The LibX thing turned out not to be the least bit straightforward, so I thought I’d post what I did in case a) you want to try this and can benefit from my hours of fumbling, or b) you are good at this and can help me make what I did better. I was helped to get this far by a librarian from the LSW.

Start an Edition

In the Edition Builder, it might be a good idea to first search for the Carleton College edition and copy that to use as a base, or you can click “Build a New Edition” on the right of the page.

From here, there’s one confusing thing that will help for the rest of the time. To find your edition and edit and test it, you’ll click on the “my editions” tab. Then click on the edition name on the lower left side. THEN click on the revision you want to work on in the list of revisions that shows up to the right of the “Select an Edition” box. THEN, if you don’t see a “Revision x is being worked on” notification, you’ll have to either click “Open Revision x (modify)” or, if you have a live revision that you want to modify you’ll have to click “Copy Revision x Forward.” At this point you’ll end up with tabs across the top to configure the various different functions of the LibX extension.

Configuring your Primo instance with LibX

You’ll need the Web Developer extension (chrome or firefox) to find the variable names LibX asks for. Once you’re armed with that, click on the “Catalogs & Databases” tab in the LibX Edition Builder for your new Edition.

LibX catalog

I tried to get LibX to auto-detect my catalog’s settings, but it kept saying that it couldn’t do it, so I had to resort to manual set-up. So under “Manual Configuration” I chose ExLibris Primo and then clicked “Add Catalog.” After this you’ll need to add information to both the “Required Settings” and the “Optional Settings” for the catalog (my edition didn’t work at all until I added some things to the “optional” settings… so apparently they aren’t terribly optional).

The URL you need is JUST the base URL up to the .com. All the other parameters that ExLibris puts into Primo URLs have to be added in other spots.

Then you’ll need to find things that LibX calls “Advanced Search Choice Variable 1,” “Advanced Search Mode Variable 1,” etc. Fire up the Web Developer “Inspector” tool and point it to the boxes I’ve labeled here:

advanced search variables

When you click the Inspector tool on the Advanced Search Choice Variable 1 (the first search box), you’ll find the variable name in the Web Developer browser pane:

variable name

Put that value into the corresponding field in LibX, finding and entering each of the variable names in the required fields in LibX.

You’ll find your VID in the standard URL for your catalog. I’ve bolded our VID in our URL here:

In the Optional settings, you’ll need to fill in 5 of the fields, as far as I can tell:

  1. In “Path” put “/primo_library/libweb”
  2. In “Search Function” put “search”
  3. In “Basic Mode Variable” try putting in “vl(1UIStartWith0)” — you may have to adjust this, but it’s worth a try.
  4. In “Tab Variable” put “default_tab”
  5. And in Title Search Mode put “contains”

Beyond the Catalog

The thing I use LibX most for is the added right-click context menu in my browser that allows me to reload the page through my library’s off-campus access, so I highly recommend putting your proxy information into the “Proxy Access” tab on the LibX Edition Builder.

You can also add your Open URL base url to the OpenURL Resolvers tab. If you do this and select a logo, then that logo will appear next to citations online, allowing you to click on the logo and check for library access. (You can add your own logo in the “File Management” tab.)

Testing your Edition

Back in the “My Editions” page, click on the Revision you’ve been working on and then click the link that appears below it called “revision test page.” If you can search your catalog through the test page, congratulations! If not, I don’t have a lot of advice beyond asking around and maybe trying to have the LibX folks help you out (you can click “help me with x edition” in the “Select an Edition” box to the left of the list of revisions).

Go Live

Once things are ready, click on the revision you’ve been perfecting and then click “Make Revision x Live.”  Now people will be able to download the LibX extension for Chrome or Firefox, tell it which library they want, and start using it.


3 thoughts on “Building a LibX Edition for Primo

  1. Hi Iris, Thank you very much for this post – we recently migrated to Primo and I was very happy to find your post re. LibX and Primo (the optional fields were especially informative!). We have the new Primo interface so I had to create a bookmarklet in the end instead of the ExLibris Primo Catalog option but I have submitted our URL to LibX and hope that the new interface setup will be included.

  2. I’m so glad it was useful, and thanks for the nudge about the new UI. If you hear that there’s a way to make LibX work with that, could you let me know? And I’ll post if I hear it first.

Leave a Reply