Odyssey Keys

Follow

All of the following keys are found in the Customization table and can be accessed via the ILLiad Customization Manager under Odyssey | Defaults unless otherwise noted.

For Shared Server ILLiad systems, each NVTGC site in the Shared Server system may independently elect to use or not use Odyssey. One NVTGC site deciding to use it will not force other sites to do so as well. However, UseOdyssey is a global key in the sense that it MUST be set to Yes for the ILL NVTGC (regardless of whether the ILL NVTGC is actually used by the institution) before it will function for ANY NVTGC site.

In order to give receiving Odyssey servers an opportunity to correct standard network connectivity errors and the occasional reboot, we recommend not setting the OdysseySendInterval value smaller than 300 (5 minutes). For Shared Server ILLiad systems, OdysseySendInterval is a global key in the sense that it MUST be set to the same value for ALL NVTGC sites, including the ILL NVTGC (regardless of whether the ILL NVTGC is actually used by the institution), before it will function for ANY NVTGC site.

UseOdysseyYes, NoThe UseOdyssey key enables or disables Odyssey functions. If the key is set to Yes, Odyssey functions are enabled. If set to No, Odyssey will not function, and Odyssey-related options and menus will not display in the ILLiad client.
OdysseyReceiveYes, NoEnables Odyssey receiving functions for Borrowing. If set to No, you can still use Odyssey (if UseOdyssey = Yes) for sending and Document Delivery but not for receiving documents from other libraries.
OdysseySendYes, NoSpecifies whether Odyssey should be used, if available, for sending Lending articles. If set to No, transactions will be routed to the Awaiting Shipping Label Printing queue.
OdysseySystemID123.123.123.123/ILL (for a standard single site ILLiad Database) 123.123.123.123/XYZ (for a multi-site Shared Server ILLiad Database)The OdysseySystemID key identifies your Odyssey Server (the machine where the ILLiad Odyssey Manager resides) and your specific NVTGC site to other Odyssey Servers. This identifies both the IP address of your Odyssey Server and your specific library on the Odyssey Server in a Shared Server environment. If your Odyssey Server is a different machine than your Database Server, give the IP of the Odyssey Server. Most single-site ILLiad systems will use the ILL site designation. Shared Server ILLiad systems will have this key repeated for each NVTGC site on the Shared Server.
ILLiadServerIP123.123.123.123The ILLiadServerIP key identifies your Odyssey Server (the machine upon which the ILLiad Odyssey Manager resides) for use by your own local ILLiad clients in processing Electronic Delivery items. If your Odyssey Server is a different machine than your Database Server, give the IP of the Odyssey Server.
SystemIDOCLCSymbolABC, XYZThe SystemIDOCLCDefault key identifies your institution's OCLC symbol to other ILLiad systems. This key is accessible from the Customization Manager under System | General.
SystemIDDOCSymbolABCDEF, XYZPDQThe SystemIDDOCSymbol key identifies your institution's Docline symbol to other ILLiad systems. This key is accessible from the Customization Manager under System | General.
SystemIDISOSymbolABC, XYZPDQThe SystemIDISOSymbol key identifies your institution's ISO symbol to other ILLiad systems. This key is accessible from the Customization Manager under System | General. Note: This value should be consistent with the value used in your ISOSystemID field. The ISOSystemID field is accessible in the Customization Manager under System | ISOILLDefaults.
OdysseyServerReceiveDirc:\illiad\odyssey\receive\The OdysseyServerReceiveDir key designates the temporary storage location of received Odyssey documents on the ILLiad server prior to processing. Once successfully processed, the files are deleted from this receive folder and stored in the received subfolder. This path should be a local path to a folder on the Odyssey Server.
OdysseyServerSendDirc:\illiad\odyssey\send\The OdysseyServerSendDir key designates the temporary storage location of scanned Odyssey documents on the ILLiad server prior to sending. Once successfully processed, the files are deleted from this send folder. Documents that failed to send are stored in the Failed subfolder. This path should be a local path to a folder on the Odyssey Server.
OdysseyMaxSendTries5, 10The OdysseyMaxSendTries key designates the number of times the system will attempt to send an Odyssey document to the Borrowing institution prior to changing the transaction status to Odyssey Sending Failed.
OdysseySendInterval600, 1200The OdysseySendInterval key designates the number of seconds the system will wait between attempts to send an Odyssey document to the Borrowing institution.
OdysseyReminderYes, NoThe OdysseyReminder key tells the ILLiad client whether or not to display the Odyssey Reminder message in Lending upon marking the item as found after Stacks Searching. The purpose of the message is to remind the ILL staff to scan the article as an Odyssey request as opposed to some other document scanning process.

Questions?

If this article didn’t resolve your issue, please take a moment and answer a few questions to help improve our documentation:

Feedback