/
ILLiad CaiaSoft Server Addon

ILLiad CaiaSoft Server Addon

This is a Server Addon and is installed using the ILLiad Customization Manager. See Installing and Configuring ILLiad Server Addons for more information.

Name

Caiasoft Remote Storage Integration

Version

1.2.0

Author

Atlas Systems, Inc.

Description

Sends circulation requests to CaiaSoft for offsite requests.

 

Download

 

Release Notes

  • v1.2.0:

    • Updated the method used to import .NET assemblies. This does not affect addon function.

    • Fixed a bug that was causing the User-Agent header to be set to “Aeon-Addon.” It is now set to “ILLiad-Addon.”

 

Configuration

Contact Laura Beatham for more information on configuration the CaiaSoft side and to obtain a CaiasoftAPIUrl and APIKey that is necessary to configure the ILLiad addon. Addon settings are configured in the Manage Addons form. The following settings must be set for each instance of the addon:

  • CaiasoftAPIUrl

  • APIKey

  • BarcodeMapping

 

There are also some custom queues that should be configured depending on the configuration of the addon. With the default settings, you'll want to create the following custom queues in the Customization Manager.

  • Awaiting Offsite Request

  • Awaiting Offsite Delivery

  • Error Processing Request

 

Caiasoft will also require some additional data about your ILLiad configuration. You should generate a new API key in the ILLiad Web Platform Config table so that Caiasoft can update requests in ILLiad after the addon sends requests. The image below shows an example of the new WebPlatformConfig entry.

Sample WebPlatfomConfig Entry for Caiasoft Integration
Sample WebPlatfomConfig Entry for Caiasoft Integration

Settings

Name

Type

Default

Description

Name

Type

Default

Description

CaiasoftAPIUrl

String

https://yourlibrary.caiasoft.com/api/

The Caiasoft API URL

APIKey

String

 

The API Key for authenticating to the Caiasoft API

BarcodeMapping

String

ItemNumber

The transaction field that contains the barcode of the material that should be requested via Caiasoft

MonitoredStatus

String

Awaiting Offsite Request

The queue that the addons will monitor for new offsite requests

ProcessedStatus

String

Awaiting Offsite Delivery

The queue that the request will be moved to after the offsite retrieval request has been submitted

ErrorStatus

String

Error Processing Request

The queue that the request will be moved to if an error occurs during the offsite requesting process

HistoryEntrySuccess

String

CaiaSoft: Request Posted. (Barcode: {barcode})

The history entry made when the request is processed by CaiaSoft. Leave blank for no history entry