Installing GOBI plugin

Installing GOBI plugin





How to install the GOBI plugin



This plugin is designed to provide an easy integration for the GOBI Library Solutions from EBSCO.  

It registers purchase orders into Koha based on the GOBI message it receives.

It is intended to serve as a testbed so the feature can get into Koha's source code.

GOBI messages include a basic MARC21 record for the purchased item(s).  

This MARC21 record is added to Koha and linked to the generated purchase.

It follows the implicit Koha workflow, which includes:

  1. Parse GOBI purchase order.

  2. Verify the GOBI order includes mandatory data and valid.

  3. Create a purchase basket.

  4. Store the GOBI order in the plugin's table, including the basketno.

  5. Add MARC record.

  6. Add the required items (based on quantity) if AcqCreateItem is set to ordering.

  7. Create an order, attach the items.

  8. Close the purchase basket.

Details about the plugin can be found here: 

https://github.com/thekesolutions/koha-plugin-gobi

Step 1: Preparing the System

To start, ensure your system is set up to allow plugins. 

There is another FAQ for this procedure, please feel free to contact Interleaf for more information if 

necessary. 

If plugins are successfully enabled on your system, the plugin page should look something like this


Step 2: Installing the Plugin

Go to- https://github.com/thekesolutions/koha-plugin-gobi/releases and download the most recent 

.kpz file. 

On your KOHA system go to KOHA Administration>Plugins>Manage Plugins>Upload Plugin

Click the Upload Plugin button. This will bring you to a new page where you will be prompted to 

upload the .kpz file you just retrieved from github.

Upload the .kpz file. When the file has been uploaded successfully, it will appear in the table of 

plugins on your system, similar to this:



Step 3: Configuring the plugin

  • Create a GOBI vendor in Koha. Make a note of  the vendor id (booksellerid on the URL).

  • Go back to the plugins page,  go to Actions on the right hand side and select Configure from 

the dropdown.

  • Put the vendor id on the GOBI vendor id field.

  • Generate an API key by clicking on the refresh icon.


  • Set the 'Not for loan' value to suit your needs.

  • Save.

 

Step 4: Configure GOBI

Your GOBI representative will require the following information:

  • The generated API key

  • The URL for your staff client (HTTPS is mandatory for security reasons)

You will need to send GOBI some CSV files, each containing:

  • branchcode and branchname (for use in Location).

  • fund ids and fund names (for use in FundCode).

  • item type ids and item type descriptions (for use in Local Data 1).

  • shelving location codes and shelving location descriptions (for use in Local Data 2).

Step 5: Currencies

GOBI handles USD and GBP as currency codes. They need to be set likewise in Koha.

NOTES from the developer Tomas Cohen Arazi

  • GOBI only accepts the value in the response message. Because of this, and in order to be 

able to match the full record using 999$c later (once the full record is submitted), the plugin 

returns the resulting biblionumber on that field until GOBI accepts more information to be 

returned.

  • It is not clear if GOBI price includes taxes, and which percentage.

  • There might be some discount applied that is not included on the GOBI message.

  • We are not checking if funds are enough and what to do in that case.

  • GOBI orders visualization needs some love, based on users input.

License

See the LICENSE file on the root directory.







Version History 

Version

Date

Detail

Author

1.0

17/07/2019

Document Created

Daphne Hoolahan

2.0

15/05/2020

Transferred to Zoho

Daphne Hoolahan













Retention Policy

Permanent

X



    • Related Articles

    • How to install and configure the coverflow carousel plugin on Koha

      Step 1 - Preparing the System To start, contact Interleaf to ensure that the plugin system is enabled in the configuration file on your Koha database. Once this has been confirmed, go to Koha Administration > Global System Preferences > ...
    • How to install and use the Bywater support plugin

      It is possible to install a plugin that will allow practitioners on the staff interface to ask queries and provide details of issues directly to an email support account from within the Koha application. Step 1 - Download the plugin Go to ...
    • Installing and using the Unused Authority Report plugin

      Installing and using the Unused Authority Report plugin This tool enables library staff to check if there are any authorities on their site that are not in use on any catalogue records.  Step 1: Download the plugin Go to ...
    • Restore Deleted Item Records Plugin

      This document outlines how to install and use a plugin which allows deleted item records to be restored based on the date(s) that they were deleted. Step 1 - Download the Plugin Go ...
    • Install LPTOne Client

      Install LPTOne Client To install the LPTOne client you will first need to know the version required, to find the compatible version on to the Management Console/JQE PC navigate to C:\Program Files (x86)\EnvisionWare\lptone\lptjqe and right-click on ...