Tech Blog

Self-Check Web Based Application

Disclaimer

This web app is using several Alma APIs and in order to have it working you will need to disable CORS as described below. Note that this is not the preferred way of using APIs and communicating information as described in the blog entry here: https://developers.exlibrisgroup.com/blog/Alma-Analytics-Data-in-a-Google-Chart#CORS

To disable CORS – start the browser in kiosk mode:
Create shortcut: “< Chrome Executable Path > –kiosk –disable-web-security –user-data-dir <HTML file path>”

Description

The web based app allows a simple interface for patrons to scan their ID, continue and scan their items to be checked out.

Familiarize Yourself with the Developer Network

  • If you haven’t done so yet, please sign up to the Developer Network
  • Login to the Developer Network
  • Click on the “Dashboard” option and select the “Applications” option in the left-side menu
  • Create a new application and add the “Bibs” and “Users” API
  • Make sure the API is running against the environment you’re interested in checking items out (sandbox/production)

Installation Steps

  1. Create the Developer Network application as described above
  2. Download the project from GitHub: https://github.com/idopeledexl/selfcheck
  3. Replace the “logo.png” file under the “images” folder to your institution’s logo (or the desired one)
  4. Open the “self-check.js” file found under the “js” folder and make the following changes:
    1. In line 3 change the “apiKey” to the API key created in step 1
    2. In line 5 change the “libraryName” to your library code
    3. In line 6 change the “circDesk” to your circulation desk code
  1. Open the “self-check.html” file

Screenshots

Homepage:

User details/check-out page:

Download Code

The code can be found in this GitHub project: https://github.com/idopeledexl/selfcheck

5 Replies to “Self-Check Web Based Application”

  1. Hello Ido,

    We’re currently running EnvisionWare with Stunnel with Alma for self-checkout. However, we’re considering replacing EnvisionWare with your web-based self-checkout app.

    Do we need to re-configure Stunnel to get this to work?

    What type of platform do we need to use when creating the Alma API key: “Integration, Multi-purpose, Other, Script/batch, Smartphone app, or Web application”? We seem to have made the most progress with the “Web application” platform, but checkout doesn’t seem to be working correctly…

    Thanks,

    Ryan

    Ryan Edwards
    Digital Access and Systems Librarian
    Getty Research Institute
    reedwards@getty.edu

  2. Hello Ido,

    We have another question – If you don’t need to use/reconfigure Stunnel, did you have to get your IT Department to open their firewall to the Alma API on the workstations where you installed this self-check application?

    Thanks,

    Ryan

    Ryan Edwards
    Digital Access and Systems Librarian
    Getty Research Institute
    reedwards@getty.edu

  3. Hi Ryan,

    Thanks for posting these two questions:

    1. I don’t believe the type of integation (Integration, Multi-purpose, Other, Script/batch, Smartphone app, or Web application) actually determines the use, but I’d go with Web-Application as it’s closest to what this self-check does.

    2. Yes, you will need to open the firewall in the work stations so they could communicate directly with the Alma APIs.

    Please note that I recommend asking on the Alma-L and perhaps opening a support ticket to see what other institutions are using for self-check. My development is very simple, but also very naive in a way and the communication, including the API key and user id are simply sent between the workstation and Alma.

    So do take my comment at the top of the blog to heart (also here):

    Note that this is not the preferred way of using APIs and communicating information as described in the blog entry here: https://developers.exlibrisgroup.com/blog/Alma-Analytics-Data-in-a-Google-Chart#CORS

    Hope this helps,
    Ido

Leave a Reply