LibChat to Summon

Easily get your LibChat into Summon 2.0

ProQuest's Summon 2.0 has a spot for LibChat settings in its Administration Console, but it doesn't work. If you want to get your LibChat into Summon 2.0, you'll have to do it through Summon's custom JavaScript feature.

That's fine if you're a developer, or have experience with JavaScript? But what about the rest of the libraries? That's why I created this tool. In just a few steps, I'll help you get LibChat working in your Summon instance in 5 easy steps.

What you'll need:

  1. A LibAnswers/LibChat account for your library
  2. A login for your library's Serials Solutions Client Center, with Summon admin permissions
  3. A web host where you can save a JavaScript file, or a Dropbox account. Your library's CMS will probably work.
  4. 10 minutes.

Ready? Let's Get Started.

Step 1: Get your LibChat "Hash"

LibChat works by dynamically loading a chat "widget" from the Springshare servers into Summon. It knows which widget to load by giving each widget it's own "hash," which is a long string of random-looking characters. We'll need the hash for your widget so that we can load it in Summon.

  1. Log in to your library's LibAnswers site
  2. Click on 'LibChat' in the Orange header, then select 'Chat Widgets'
    Navigate to LibChat > Chat Widgets
  3. Find the chat widget you want to use in the list, then click the "View Code" icon on the right.
    View the Widget Code
  4. Select the code from the box that popped up by clicking on the text and pressing Ctrl-C
    Copy the widget code
  5. Now paste the code into the box below.

Nice work! On to the next step.

Step 2: Test and save your new JavaScript file

I've generated the JavaScript file you need to load into Summon, but first, I'd like you to test it.

  1. First, click in the box below and copy all the code by pressing Ctrl-C.
  2. Now open up a new window or tab in your browser and go to your library's Summon site. Do a search so that you have a sceen with some results, like this:
    Summon results screen
  3. I want you to open up your browser's "Developer Tools Console." In most browsers, you can right-click on the web page and click "Inspect Element," and then click the "Console" link. If you need help finding it, head over to Andromeda Yelton's Excellent Intro to Programming page and look over her tips for finding your browser's Developer Tools Console. I'll wait!
  4. You should see a chevron in the console with a cursor next to it.
    Chrome's Developer Console
    I want you to click next to that chevron and then paste the code you copied earlier. You can press Ctrl-V for that. Once you've pasted the code, hit enter.
  5. Now move the Developer Tools window so you can see your Summon site. Do you have a chat button in the upper right hand corner, like this?
    You should have a chat button here
  6. Yesss!

    Now we need to save the JavaScript file on your desktop. Go ahead and click the download button below.

    Download the LibChat2Summon script

    Got it! Take me to the next step

    Oh no!

    Take a look at the Developer Tools console, where you pasted the code. Did you get any red messages? They'll help determine what the problem is. For now, copy that message and email it to reidsmam@gvsu.edu and I'll try to help you work out what went wrong!

Step 3: Upload your file to a server

Summon needs to be able to load the JavaScript file we just created, so we need to get it somewhere on the internet. You can probably use your library's Content Management System (like Wordpress or Drupal) to host that. If you don't have access to a place to host the file, then you can use Dropbox to host your script.

To use Dropbox:

  1. Save the libchat2summon.js file you just downloaded into your Dropbox "Public" folder. Wait for the file to sync.
  2. Right-click (Ctrl-click on Mac) on the file, and select "Copy Public Link."
  3. Paste that link into the box below.

Okay! I've uploaded my script! Show me the next step.

Step 4: Customize Summon 2.0 to load your new JavaScript file

Now we're going to tell Summon where to find your script.

  1. Log in to the Serials Solutions Client Center.
  2. Click on the Summon Administration Console.
    The second-to-last setting is for the script
  3. Scroll all the way to the bottom of the Adminstration Console. The second-to-last box is called "Summon 2.0 External Script".
    The second-to-last setting is for the script
  4. Click in the box below and copy the URL (Ctrl-C):
  5. Paste (Ctrl-V) that URL into the field for the "Custom Script URL".
  6. Click "Save Settings" at the bottom of the form.
  7. Almost done! Let's go to the last step!

Step 5: Test and Celebrate!

Now let's go back to your library's Summon site and do a new search. You should see your new chat box in the upper right hand corner!

Did it work?

Congratulations!

Celebrate!

Uh-oh. Something went wrong.

The easiest thing to do right now is email reidsmam@gvsu.edu and tell me what happened. I'll take a look and see if we can get it working!