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

Upgrading to the .NET Odyssey Manager

In ILLiad 10, Odyssey Manager was rewritten from Delphi as a .NET 10 Windows Service. This page is for sites that already run ILLiad and are updating to ILLiad 10 — it covers cutting the server over from the old service to the new one. For a summary of what changed, see What's new in the Administrator Guide.

Setting up for the first time?

If this is a fresh install rather than an update, follow Setting up the Odyssey Manager instead.

Before you start​

  • .NET 10 runtime on the ILLiad server (installed as part of the ILLiad 10 install).
  • The ILLiad database reachable from the server, and the ILLiad logon database (.dbc) in place — the service uses it to connect.
  • If you use Article Exchange, the four OCLC credentials set in Customization Manager.

Cutover steps (on the server)​

  1. Stop and remove the old Delphi Odyssey Manager service. Stop the existing Odyssey Manager service on the server and remove it before deploying the new one.
  2. Deploy the .NET Odyssey Manager files. The files are delivered through the standard ILLiad update process, not copied by hand:
  3. Run the runtime installer(s) that come with the update to install the .NET 10 runtime on the server. (The runtime ships with the update — you don't download it separately.)
  4. Copy the updated ILLiad Updater into your ILLiad\Admin folder.
  5. Run ILLiadUpdate.exe /IUFile=ILLiad-10-Odyssey, which places the Odyssey Manager files into the Odyssey installation directory and updates the ILLiad Odyssey Manager Windows Service.
  6. Check appsettings.json. Set DataPath (required), and change ListenPort only if your site uses a non-default port (the default is 7968). Leave the poll-interval settings at their defaults unless you have a reason to change them.
  7. Confirm the logon database. Make sure the .dbc file is accessible and has the correct connection string.
  8. Confirm your customization keys carried over. The service reads the same families of Odyssey keys the Delphi build used — trust policy, retry policy, cover sheets, local system IDs — plus the billing gates. Review them for each of your NVTGCs (see Customization keys).
  9. Start the service and watch the logs for a clean startup.
  10. Verify. Confirm a recent Last Run heartbeat, send a test document each way (inbound and outbound), and check that a delivered PDF appears at the WebPDFPath location with its cover sheet and correct page count.
Two things to know about the upgrade
  • AtlasPDF is no longer needed. PDF merge and TIFF-to-PDF conversion are built in now, so you can retire the external AtlasPDF tool.
  • Automatic billing is now built in. Odyssey billing runs inside the service (Doc Del on receive, Lending on send) instead of being applied by the EDU or done manually — so confirm BillingActiveLending and BillingActiveDocDel are set the way you intend. See Automatic Billing.