Skip to main content
Version: ILLiad 10.0 (Pre-release) 🚧

Setting up the Odyssey Manager

This page is for fresh installs — a new ILLiad site or server. It walks through installing the service and the settings you configure once. If you're updating an existing site to ILLiad 10, start with Upgrading the Odyssey Manager instead.

Prerequisites​

  • .NET 10 runtime on the ILLiad server (part of the ILLiad 10 install).
  • Database access — the ILLiad logon database (.dbc), which the service finds automatically, pointing at a SQL Server the service account can reach.
  • A data directory the service account can read and write (your DataPath).
  • OCLC Article Exchange credentials if you'll use Article Exchange (all four).

Install the service​

  1. Deploy the files. In production the standard ILLiad installer places the files and registers the ILLiad Odyssey Manager Windows Service. (To register by hand on a test host, use the sc.exe commands in the Administrator Guide.)
  2. Configure appsettings.json. Set DataPath (required — the service won't start without it), keep ListenPort at 7968 unless your site uses a different Odyssey port, and leave MaxConcurrentProcessing at 20 unless you have a reason to change it.
Ports

Odyssey Manager listens on the standard Odyssey port 7968, already documented in ILLiad's Network Ports page as required inbound/outbound. There's no new port to open.

Set the customization keys​

Most of Odyssey Manager's behavior comes from ILLiad customization keys, set per NVTGC in Customization Manager. At minimum, review:

  • WebPDFPath — where delivered PDFs are written. If this isn't set, delivery fails with "PDF Conversion Failed," so set it first.
  • Cover-sheet keys — OdysseyPDFCoverSheetLocation / OdysseyPDFCoverSheetFileName (and the DocDelPDFCoverSheetLocation / DocDelPDFCoverSheetFileName pair for Document Delivery). See Built-in PDF Processing.
  • Trust policy — OdysseyAutoElecDel (and ArticleExchangeTrusted) decide automatic vs. manual handling of inbound deliveries.
  • Retry policy — OdysseyMaxSendTries (default 4) and OdysseySendInterval (default 300s), plus SendArticleExchangeOnOdysseyFailure if you want Odyssey failures to fall back to Article Exchange.
  • Article Exchange — OdysseyServerReceiveDir to enable the inbound watcher, and the four OCLC credentials.

Finish setup​

  1. Verify Article Exchange credentials (if used). All four OCLC keys must be set at the parent site, or Article Exchange uploads fail authentication. The four keys are OCLCWebServiceV2APIKey, OCLCWebServiceV2APISecret, OCLCILLAuthorization, and OCLCILLPassword — see the Administrator Guide for detail.
  2. Set the billing gates you want. Turn on BillingActiveDocDel and/or BillingActiveLending if you want automatic billing; leave them off if not. See Automatic Billing.
  3. Start the service and confirm the heartbeat. Check for a recent Last Run on the Odyssey Manager source, then send a test document each way and confirm a delivered PDF at WebPDFPath with its cover sheet.