Aeon CaiaSoft Server Addon

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

Name

Caiasoft Remote Storage Integration

Version

1.1.4

Author

Atlas Systems, Inc.

Description

Sends requests to CaiaSoft for offsite requests.

Download

Configuration

If you have any questions about installing and configuring the addon or any workflow questions, please contact Katie Gillespie via support@atlas-sys.com

Contact Laura Beatham for more information on configuration the CaiaSoft side and to obtain a CaiasoftAPIUrl and APIKey that is necessary to configure the Aeon addon. 

To install this server addon, create a new server addon via customization manager by following the steps outlined in documentation. The following settings must be set for each specific library:

  • CaiasoftAPIUrl

  • APIKey

  • StopCodeField

  • StopCodeMappings

  • 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’ - with a state code of ‘In Item Retrieval’

  • ‘Awaiting Offsite Delivery’ - with a state code of ‘In Item Retrieval’

  • ‘Error Processing Request’ - with a state code of ‘Awaiting Request Processing’

Settings

Setting

Type

Default Value

Description

CaiasoftAPIUrl

String

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

The Caiasoft API URL

APIKey

String



The API Key for authenticating to the Caiasoft API

StopCodeField

String

{TableField:Transaction.Site}

Defines the transaction field in which the stop code will be stored.

StopCodeMapping

String

 

Comma-separated list of CaiaSoft stop codes. (Example: ILL=Admin,MAIN=MAIN)

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

JSON Templates - Datamapping

The JSON templates used to create the request to the Caiasoft API can be customized in the DataMapping.lua file. The mapping makes use of tag replacements.

The TableField tag allows for replacing a value from another Aeon table. The addon can support retrieving values from the User, Transaction, or LocalInfo tables. The tag syntax uses pipes to denote a tag and must start with TableField: followed by the Aeon table, then a period, and finally the field name. Example: {TableField:User.FirstName}. User and Transaction custom fields are also supported. Example: {TableField:User.CustomFields.FavoriteColor}.

An optional ,EscapeQuotes, may be added to ensure the tag replacement has all quotes escaped so that it does not alter the JSON structure. E.g. If the tag "{TableField:Transaction.ItemTitle,EscapeQuotes}" is used, a title of “The Lost Library” will be replaced as “\”The Lost Library\“”

Combining tags and static text

When the addon setting is evaluated tag replacement values are processed and all other text stays as-is. As an example, to set the TransactionNumber value to have a prefix of “Aeon TN:”, the setting value would be set to Aeon TN:{TableField:Transaction.TransactionNumber}. This would get evaluated as “Aeon TN:12345” if the addon was processing transaction 12345.