Aeon Configuration & Requirements

Description

The CaiaSoft™ / Aeon integration is a two-way connection using API keys. When a request is moved into a monitored queue in Aeon, a call is made to the Caiasoft™ REST API (/circrequests) and the item is placed on a job for processing. Upon the item's retrieval and subsequent refile, the Aeon queues are updated automatically via calls from CaiaSoft™ to the Aeon API.

CaiaSoft™ /Aeon API Integration Workflow

CaiaSoft™ /Aeon Queue Utilization

Aeon Configuration

Contact your Aeon representative to install the Aeon Addon.
The following information will need to be provided to them:

  • Your CaiaSoft™ URL (https://yourlibrary.caiasoft.com/api)
  • An API key for authentication of the Aeon → CaiaSoft™ connection (see External Links in the Admin Module)
  • The custom queue to monitor for requests (i.e. "Awaiting Offsite Request")
  • The queue that the request will be moved to if an error occurs during the offsite requesting process

CaiaSoft™ Configuration

Use the Administration Module, the API & External Links button to see view/edit all settings.
If your facility is using multiple Aeon connections for different collections, contact CaiaSoft™ support to assist in the initial setup.

Required Fields for Setup

FieldTypeDescriptionExample
Aeon URLstringThe Aeon API URLhttps://library.aeon.atlas-sys.com/aeon/api
API Key (Aeon ← CaiaSoft™)stringThe API Key for authenticating to the Aeon API
Check OUT move to Queueint or stringEither the queue number or name an item will be moved to in Aeon when the item has been retrieved in CaiaSoft™In Transit from Annex
Check IN move to Queueint, string or BARCODEEither the queue number or name an item will be moved to in Aeon when the item has been refiled in CaiaSoft™.
If your Aeon installation allows, use "BARCODE" here to utilize /RequestBarcode/{barcode}/reshelved API (recommended).
Request Finished
Error Queueint or stringThe queue that the request will be moved to if an error occurs during the offsite requesting process.
Note: processing errors ONLY - denied requests will be listed on the CaiaSoft™job with denial reasons.

Additional Information

See Admin Module Setup for information on the API & External Links section, and configuring Email Alerts for item denials and fulfillment.