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

ISO 18626 Setup and Configuration

ILLiad 10 adds support for ISO 18626 ILL, a peer to the existing ISO 10160/10161 ("ISO ILL") system. This guide walks a site administrator through the three things required to bring ISO 18626 online:

  1. Enabling ISO 18626 and setting its system defaults in Customization Manager.
  2. Installing (or updating) the ISO 18626 Manager server component.
  3. Configuring each lending partner as an ISO 18626 partner in Lender Addresses.
Who this is for

This is an administrator/configuration guide. Day-to-day borrowing and lending actions (Status Request, Cancel Request, Conditionalize, shipping, and so on) are covered separately in Working ISO 18626 requests.

1. Enable ISO 18626 and set system defaults​

All of the ISO 18626 system settings live together in Customization Manager under the System category, in the ISOILLDefaults group. One additional version-tracking key lives under System > Versions.

The master switch is ISO18626Enabled. Until it is set to Yes, the ISO 18626 fields on the Lender Addresses form stay hidden and the "ISO18626 Manager" row does not appear on the System Status monitor.

System customization keys (System > ISOILLDefaults)​

KeyDefaultTypePurpose
ISO18626EnabledNoYes/NoMaster on/off switch for ISO 18626 ILL capabilities. Reveals the ISO 18626 fields in Lender Addresses and the "ISO18626 Manager" status row when set to Yes.
ISO18626SystemID(empty)StringYour library's own ISO 18626 system identifier. Used as the sender symbol when shipping and when routing a request to another site.
ISO18626CurrencyCodeUSDStringDesignates the type of currency being used (e.g. USD).
ISO18626MonetaryValue15StringSpecifies the MaxCost value for ISO 18626 ILL requests and OCLC Direct Request.
ISO18626AutoUpdateAddressNoYes/NoWhether incoming ISO 18626 ILL requests overwrite the shipping address in Lender Addresses with the address supplied in the request. This is the site-wide default; it can be overridden per lender (see below).
ISO18626IFMBorrowingYesYes/NoISO 18626 ILL system setting (IFM, borrowing side). The description reads "Do not change."
ISO18626IFMLendingYesYes/NoISO 18626 ILL system setting (IFM, lending side). The description reads "Do not change."
Do not change the IFM settings

ISO18626IFMBorrowing and ISO18626IFMLending are internal system settings. Their own descriptions in Customization Manager instruct staff not to change them. Leave them at their defaults of Yes.

Version-tracking key (System > Versions)​

KeyDefaultTypePurpose
VersionISO18626Manager10.0.0.0StringTracks the installed version of the ISO 18626 Manager server component (see below). You do not set this by hand — it is stamped by the ISO 18626 Manager's own installer.
Auto Update Address default: system vs. per-lender

There are two "Auto Update Address" settings, and their defaults differ on purpose:

  • the system key ISO18626AutoUpdateAddress (System > ISOILLDefaults) is the site-wide default and ships as No, while
  • the per-lender value is stored in the ISO18626AutoUpdateAddress column on the Lender Addresses record. The database column's default is Yes, but on the Lender Addresses form the Auto Update Address checkbox appears unchecked for a new record — so a lender saved from the form stores No unless you check the box.

If you want incoming requests to update a lender's shipping address, check Auto Update Address on that lender explicitly.

How the keys arrive on your database​

The ISO 18626 customization keys are delivered as part of the ILLiad 10 update, so once your server is on ILLiad 10 they are already present — there is nothing separate to run.

  • New installations get all of the keys above (including VersionISO18626Manager) from the fresh-install seed data.
  • Existing sites receive keys 1–7 as part of the ILLiad 10 update. That update deliberately does not create VersionISO18626Manager, so that the AutoUpdater treats the ISO 18626 Manager as "not yet installed" and runs its installer. The Manager's installer then creates and stamps the version key itself.

2. Install or update the ISO 18626 Manager component​

The ISO 18626 Manager is a new ILLiad 10 server-side component. It is delivered and versioned separately from the older (legacy) ISO Manager, and it is installed by the standard ILLiad AutoUpdater as part of the ILLiad 10 update.

New component, MSI-based install

Unlike the legacy ISO Manager (which is updated by simply replacing its executable), the ISO 18626 Manager is delivered as a Windows Installer package, ILLiadISO18626Setup.msi. The AutoUpdater runs it silently (/qn REBOOT=ReallySuppress), so the install can register the service and its dependencies rather than just dropping a file into a share.

What to do​

  1. Update your server to ILLiad 10. The ISO 18626 database schema and the ISOILLDefaults customization keys (Section 1) are delivered automatically as part of the ILLiad 10 update — there is no separate database step to run.
  2. The AutoUpdater installs the ISO 18626 Manager. During the update it compares the available component version (10.0.0.0) against VersionISO18626Manager in Customization Manager. Because that key is absent on an upgrading site, the Manager is treated as version 0.0.0.0 (not installed) and the updater runs ILLiadISO18626Setup.msi.
  3. Confirm the install. After the AutoUpdater runs the MSI successfully, it stamps VersionISO18626Manager = 10.0.0.0 for the ILL NVTGC. You can verify this in Customization Manager under System > Versions, key VersionISO18626Manager (description "ILLiad ISO 18626 Manager Version").
When does the version appear?

On an upgrading site the ISO 18626 Manager only shows up in the System > Versions list after the AutoUpdater has actually run the MSI. If you do not see VersionISO18626Manager, the Manager has not been installed yet — run the AutoUpdater.

ISO 18626 Manager vs. legacy ISO Manager

These are two different components. The legacy ISO Manager (versioned by VersionISOManager) handles the older ISO 10160/10161 protocol. The new ISO 18626 Manager (versioned by VersionISO18626Manager) handles ISO 18626. Both can be present on the same server.

3. Configure a lender as an ISO 18626 partner​

Once ISO 18626 is enabled and the Manager is installed, designate each partner as an ISO 18626 partner on their Lender Addresses record in the ILLiad Client.

The ISO 18626 fields are hidden until you enable ISO 18626

The ISO 18626 Information group only appears on the Lender Addresses form when the system key ISO18626Enabled is set to Yes. If you do not see it, complete Section 1 first.

Steps​

  1. In the ILLiad Client, open Lender Addresses and select the partner's address record (by symbol / address number).
  2. In the ISO 18626 Information group, check ISO 18626 Enabled. This turns on the partner for ISO 18626 and un-grays the remaining fields — they stay disabled until this box is checked.
  3. Fill in the partner-supplied connection and credential values (see the field reference below).
  4. Optionally check Auto Update Address to let incoming ISO 18626 requests overwrite this lender's shipping address (per-lender override of the system default).
  5. Save the record.

ISO 18626 Information fields​

Field labelStored asNotes
ISO 18626 EnabledISO18626Per-lender master toggle. When checked, stored as "Yes"; enables the remaining fields.
AddressISO18626AddressThe partner's ISO 18626 endpoint address.
Agency IDISO18626AgencyIDPartner-supplied agency identifier.
Account IDISO18626AccountIDPartner-supplied account identifier.
Security CodeISO18626SecurityCodePartner-supplied security/authentication code.
Auto Update AddressISO18626AutoUpdateAddressPer-lender override for the auto-update-address behavior. Checked = "YES", unchecked = "NO"; the checkbox defaults to unchecked.
VersionISO18626VersionThe ISO 18626 protocol version for this partner.
Get these values from your partner

The Address, Agency ID, Account ID, Security Code, and Version are supplied by the partner institution you are exchanging with. Enter them exactly as provided.

Database changes introduced for ISO 18626​

For reference, the ILLiad 10 update adds the following to the ILLiad database as part of ISO 18626 support. On new installations these are part of the base schema; on existing sites they are applied by the ILLiad 10 update. Every statement is guarded, so re-running the update is safe.

New LenderAddresses columns (per-lender ISO 18626 settings)​

ColumnTypeDefault
ISO18626nvarchar(3)No
ISO18626Addressnvarchar(255)—
ISO18626AgencyIDnvarchar(50)—
ISO18626AccountIDnvarchar(255)—
ISO18626SecurityCodenvarchar(255)—
ISO18626AutoUpdateAddressnvarchar(3)Yes
ISO18626Versionnvarchar(50)—
Shared (consortial) servers

On a shared server, LenderAddresses is a per-site view over the LenderAddressesALL base table. The update adds the columns to the base table and then recreates the per-site views, so the new fields appear correctly for each site.

New Transactions column​

ColumnTypePurpose
ISO18626Statusnvarchar(50)Per-transaction ISO 18626 attention/error indicator, alongside the existing ISOStatus column. Staff clear it with the ISO Attention button in the Error Clearing group on the Errors ribbon.

New ISO18626Status table​

A per-transaction ISO 18626 status history table (one row per status change):

ColumnTypeNotes
TransactionNumberINT NOT NULLTransaction the status belongs to.
StatusNVARCHAR(100) NOT NULLThe ISO 18626 status.
CreatedDATETIME2 NOT NULLTimestamp, defaults to the current date/time.

The primary key is clustered on (TransactionNumber, Created DESC), so the newest status for a transaction sorts first.

note
Two objects named ISO18626Status

There are two distinct database objects that share the name ISO18626Status: a column on the Transactions table (nvarchar(50)) and a separate table (with a Status column of nvarchar(100)). They are unrelated despite the shared name.

Verifying your configuration​

Use this checklist to confirm ISO 18626 is ready:

  • ISO18626Enabled is set to Yes in Customization Manager (System > ISOILLDefaults).
  • ISO18626SystemID, ISO18626CurrencyCode, and ISO18626MonetaryValue reflect your library's values.
  • VersionISO18626Manager appears under System > Versions (confirms the Manager MSI installed).
  • The ISO18626 Manager row appears on the System Status monitor in the Client.
  • The ISO 18626 Information group is visible on the Lender Addresses form.
  • Each ISO 18626 partner has ISO 18626 Enabled checked with Address, Agency ID, Account ID, Security Code, and Version filled in.