Self Checkout
Introduction
The Self Checkout product integration allows library patrons to independently check out items from the library on their own using only their phones or desktop browser.
This product integration does not support self checkout that requires use of de-magnetization/RFID for library gates.
Vendors
The Self Checkout product integration supports the Ex Libris Alma vendor.
User Experience
The following section describes information relating to the user experience for the Self Checkout product integration.
User Activities
- The user can see up to 50 of their current loans.
- The user can see an image directing them where to look for the item barcode.
- The user can scan an item barcode with their device camera, or type it in manually in order to check the item out.
- Using the device camera to scan an item is a mobile-only feature.
- The Self Checkout product integration automatically supports the following barcode formats:
- QR: Square QR codes
- Aztec: Square Aztec codes
- Data Matrix: Square Data Matrix codes
- Barcode (EAN): EAN-13 or EAN-8 Barcodes
- Barcode (Code): Code-128, Code-39, or Code-93 Barcodes
- Barcode (GS1): GS1 DataBar, GS1 DataBar Limited, GS1 DataBar Expanded, and their stacked versions
- Barcode (other): Codabar, Interleaved 2 of 5 (ITF), ITF-14, UPC-E, or PDF-417 Barcodes
Authentication
Once the user is logged in to the app, authentication to Alma/Primo VE is done behind the scenes (SSO) with the AlmaID received from the IDP. A login is not required from the user at any stage. If the app sends an invalid AlmaID to Alma, the user will not be able to use this product integration.
Offline Support
No offline support is available.
Screenshots
Configuration
The following section describes configurations for the Self Checkout product integration.
To configure the Self Checkout product integration, select Add Product Integration from the Product Integrations main menu option.
Select Self Checkout and the following configuration page appears:
| Configuration Option | Description | Mandatory | Data Type | Default | Example |
|---|---|---|---|---|---|
| Manage Integration | |||||
| Enable Product Integration | Check this box to enable Self Checkout | No | Boolean | False | |
| Product Integration Description | Description for this Self Checkout instance | Yes | String | - | Library Self-Checkout |
| Screen Title | Appears in the top header | No | String | Self Checkout | |
| Vendor | |||||
| Vendor Name | Defines which vendor the integration connects to. | Yes | Object | - | Alma |
| Region |
The region your Alma instance belongs to:
|
Yes | Object | Europe | |
| API Key |
Your API key from Alma. This key should have the following permissions for the relevant Alma environment (Production/Sandbox):
See documentation in our developer network for further details. |
Yes | String | - | |
| Circulation Desk Parameter | The Alma circulation desk code that is responsible for the loan | Yes | String | DEFAULT_CIRC_DESK | |
| Library Parameter | The Alma library code that is responsible of the loan | Yes | String | MAIN | |
| General | |||||
| Default Locale | Used to help coordinate any difference in timezones. | No | String | en-gb | |
| Checkout Date Format | The format of the checkout date as shown in the "View My Loans" page | No | String | MM/DD/YY | |
| Due Date Format | The format of the due date as shown in the "View My Loans" page | No | String | MM/DD/YY h:mm A | |
| URL for Self Checkout Custom Image | Specify a custom image to display on the Self Checkout main screen. This image is usually intended to visually show patrons where the item barcode they need to scan is. The dimensions of the image will be resized and cropped to 242 x 317. If left blank, a generic default image will be used. | No | String | When no URL is configured a generic default image appears. | |
| Maximum Number of Loans |
Define the maximum number of loans to be retrieved and displayed. Should be no larger than 50. |
No | Integer | 10 | |
| Text/Labels | |||||
| Page Title | The title that appears in the landing page for the Self Checkout product integration. | No | String | Scan a book to borrow | |
| Help Text | Instructional text that appears under the page title which instructs the patron where to look for the barcode. | No | String | Find the library item barcode inside the cover of the book | |
| Scan Item Button Text | The text on the button which opens the camera to scan the item. | No | String | Scan an Item | |
| Separator Text | The text to display between the Scan Item button and the barcode manual entry field. | No | String | or | |
| Barcode Input Box Text | The text that appears in the barcode manual entry field when it is empty. | No | String | Type in barcode | |
| Submit Barcode Button Accessibility Label | Text intended to be used by screen readers when focusing on the submit button in the barcode manual entry field. Not displayed visually. | No | String | Submit barcode | |
| View Loans Text | Text for a link displayed at the top right of the Self Checkout landing page, which directs the user to a list of their current loans. | No | String | View my loans | |
| Item Barcode Label | In the View My Loans page, this is the name of the field which contains the barcode, as it is displayed to the user. | No | String | BARCODE | |
| Item Checkout Date Label | In the View My Loans page, this is the name of the field which contains the item checkout date, as it is displayed to the user. | No | String | Checkout date | |
| Item Due Date Label | In the View My Loans page, this is the name of the field which contains the item due date, as it is displayed to the user. | No | String | Due date | |
| No Current Loans Text | In the View My Loans page, this text is displayed when the user has no loans to display. | No | String | No current loans. | |
| More Loans Text |
In the View My Loans page, this text is displayed at the bottom of the page when the user has more loans than was configured to display (see Maximum Number of Loans). Use the following strings to insert the appropriate numbers:
|
No | String |
|
|
| Scanned Item Modal Title | The title of the pop-up shown after a barcode has been successfully scanned. | No | String | Scanned | |
| Close Modal Button Accessibility Label | Text intended to be used by screen readers when focusing on the X button used to exit the "Scanned" pop-up. Not displayed visually. | No | String | Close | |
| Scanned Item Modal Checkout Button Text | Text shown on the button used to checkout an item after successfully scanning its barcode, as it appears in the Scanned pop-up. | No | String | Checkout | |
| Loan Retrieval Error Text | Text to display when there is an error when trying to present the View My Loans | No | String | Error in Self Checkout | |
| Barcode Error Modal Title | Text to display when the barcode is scanned, but Alma determines it is not a valid barcode. | No | String | Barcode isn't valid | |
| Checkout Error Modal Title | Title of the pop-up displayed once a user has tried to check an item out, but the checkout failed. | No | String | Checkout failed | |
| Modal Error Message | The text which appears in the pop-up that's displayed once a user has tried to check an item out, but the checkout failed. | No | String | For more information, please ask your librarian. | |
| Modal Back Button Text | Text to display in the Back button. | No | String | Back | |
| Successful Checkout Modal Title | Text that appears in the pop-up upon a successful checkout. | No | String | You have successfully checked out! | |
| Scan Another Button Text | The text that appears on the button in the confirmation after a successful checkout, which allows you to scan another item. | No | String | Scan another | |