| Name | Alma Barcode Lookup Addon |
|---|---|
| Version | 1.1.0.1 |
| Author | Atlas Systems, Inc. |
| Description | An addon that takes an item barcode, performs an item search against the Alma API, and imports its results. |
...
Download
| Panel |
|---|
Configuration
Addon settings are configured in the Manage Addons form.
...
Below are the default data mappings from the API response to Ares, Aeon, and ILLiad and the default location of the barcodes for each product. These data mappings can be changed in the DataMapping.lua file.
| Warning | ||
|---|---|---|
| ||
Be sure to backup the |
Default Barcode Fields
| Product DataMapping | Location |
|---|---|
| DataMapping.BarcodeFieldMapping["Ares"] | Item.ItemBarcode |
| DataMapping.BarcodeFieldMapping["ILLiad"] | Transaction.ItemNumber |
| DataMapping.BarcodeFieldMapping["Aeon"] | Transaction.ItemNumber |
Field Mappings
| Mapping Name | Used to identify the mapping. The Fields to Import setting lists the Mapping Names for the addon to import. |
| Import Field | The Ares, Aeon, or ILLiad field the API response item maps to. The first value is the table the field maps to and the second value is the desired column in the specified table. |
| Object Type | Object type is the name of the response type from the API response. |
| Object Mapping | The XML node name of the data you wish to import. |
...
| Mapping Name | Import Field | Object Type | Object Mapping |
|---|---|---|---|
| CallNumber | Item.Callnumber | item | call_number |
| ISXN | Item.ISXN | item | issn |
| ISXN | Item.ISXN | item | isbn |
| Title | Item.Title | item | title |
| Author | Item.Author | item | autho |
| Edition | Item.Edition | item | complete_edition |
| Place | Item.PubPlace | item | place_of_publication |
| Pages | Item.PagesCount | item | pages |
| Publisher | Item.Publisher | item | publisher_const |
...
| Mapping Name | Import Field | Object Type | Object Mapping |
|---|---|---|---|
| CallNumber | Transaction.CallNumber | item | call_number |
| ISXN | Transaction.ItemISxN | item | issn |
| ISXN | Transaction.ItemISxN | item | isbn |
| Title | Transaction.ItemTitle | item | title |
| Author | Transaction.ItemAuthor | item | autho |
| Edition | Transaction.ItemEdition | item | complete_edition |
| Place | Transaction.ItemPlace | item | place_of_publication |
| Pages | Transaction.ItemPlace | item | pages |
| Publisher | Transaction.ItemPublisher | item | publisher_const |
...
| config.xml | The addon configuration file. |
| DataMapping.lua | The data mapping file contains mappings for the items that do not typically change from site to site. |
| AlmaLookup.lua | Handles the Alma-specific lookup logic |
| Main.lua | The Main.lua is the main file for the addon. It handles the initialization of the addon. |
| AlmaApi.lua | The AlmaApi file is used to make API calls against the Alma API |
| Utility.lua | The Utility file is used for common lua functions |
| LookupUtility.lua | Handles generic lookup logic that can be used between services |
| WebClient.lua | Used for making web client requests. |
...