ISO 18626 Data and Upgrade Notes

This page is a reference for ILLiad administrators and DBAs. It documents the customization keys, database schema changes, and upgrade behavior that support ISO 18626 ILL in ILLiad 10. For the day-to-day workflow (configuring a lender, sending and working requests), see the other pages in this section.

Who this page is for

This is reference material — key names, defaults, column definitions, and upgrade mechanics. You do not need to run any SQL by hand: the schema and keys are delivered automatically by the ILLiad update process described under Upgrade behavior.

Customization keys

All of the ISO 18626 settings live in the Customization Manager under the System category. Seven configurable keys are grouped under ISOILLDefaults (the ISO ILL Defaults settings). One additional version-tracking key lives under Versions.

System > ISOILLDefaults

Key	Default	Type	Purpose
ISO18626Enabled	No	Yes/No	Master on/off switch for ISO 18626 ILL capabilities. When No, the ISO 18626 UI is hidden in the ILLiad Client (for example, the ISO 18626 Information group on the Lender Addresses form and the ISO18626 Manager row on the System Status monitor).
ISO18626SystemID	(empty)	String	Your site's own ISO 18626 system identifier (the sender symbol used when your library ships or routes ISO 18626 requests). Set this before sending ISO 18626 traffic.
ISO18626CurrencyCode	USD	String	The currency code used for ISO 18626 ILL (for example, USD).
ISO18626MonetaryValue	15	String	The MaxCost value applied to ISO 18626 ILL requests and OCLC Direct Request.
ISO18626AutoUpdateAddress	No	Yes/No	Site-wide default controlling whether an incoming ISO 18626 ILL request is allowed to overwrite the shipping address in Lender Addresses with the address supplied in the request. See the note below about the related per-lender field.
ISO18626IFMBorrowing	Yes	Yes/No	Internal ISO 18626 ILL system setting for borrowing. The key description states: "Do not change."
ISO18626IFMLending	Yes	Yes/No	Internal ISO 18626 ILL system setting for lending. The key description states: "Do not change."

Do not change the IFM keys

ISO18626IFMBorrowing and ISO18626IFMLending are internal system settings. Both are shipped as Yes and carry the description "Do not change." Leave them at their defaults unless directed otherwise by Atlas Support.

Two settings share the name "Auto Update Address"

There are two distinct settings with this name, and they have different defaults:

• The customization key ISO18626AutoUpdateAddress (System > ISOILLDefaults) is the site-wide default and ships as No.
• The per-lender column LenderAddresses.ISO18626AutoUpdateAddress has a database default of Yes, but on the Lender Addresses form the Auto Update Address checkbox (in the ISO 18626 Information group) appears unchecked for a new record — so a lender saved from the form stores No unless you check the box.

These are separate values on purpose. To have incoming requests update a lender's shipping address, check Auto Update Address on that lender explicitly.

System > Versions

Key	Default	Type	Purpose
VersionISO18626Manager	10.0.0.0	String	Tracks the installed version of the ISO 18626 Manager server component. The ILLiad AutoUpdater compares this key against the component manifest to decide whether to install the ISO 18626 Manager, and stamps the key after a successful install.

About the version key on upgrades

On a fresh install, VersionISO18626Manager is seeded as part of the initial database. On an existing site being upgraded, the schema update deliberately does not create this key. That is intentional: the ILLiad updater installs a new component only when its version key is absent (treated as 0.0.0.0 = not installed). If the key were pre-set, the updater would think the ISO 18626 Manager was already installed and skip it. The ISO 18626 Manager's own installer stamps the key when it runs, so on an upgraded site the version appears under System > Versions only after the AutoUpdater has installed the Manager.

Database schema changes

ISO 18626 introduces three schema changes. They exist in the fresh-install database and are added to existing databases by the guarded upgrade (see Upgrade behavior).

1. New LenderAddresses columns

Seven columns are added to LenderAddresses to hold each lender's ISO 18626 configuration. These back the fields in the ISO 18626 Information group on the Lender Addresses form.

Column	Type	Nullable	Default	Notes
ISO18626	nvarchar(3)	NULL	'No'	Per-lender ISO 18626 enabled flag (constraint DF_LenderAddresses_ISO18626).
ISO18626Address	nvarchar(255)	NULL	—	Partner's ISO 18626 endpoint address.
ISO18626AgencyID	nvarchar(50)	NULL	—	Partner-supplied Agency ID.
ISO18626AccountID	nvarchar(255)	NULL	—	Partner-supplied Account ID.
ISO18626SecurityCode	nvarchar(255)	NULL	—	Partner-supplied Security Code.
ISO18626AutoUpdateAddress	nvarchar(3)	NULL	'Yes'	Per-lender override for auto-updating the shipping address (constraint DF_LenderAddresses_ISO18626AutoUpdateAddress). Note this default differs from the site-wide key default of No.
ISO18626Version	nvarchar(50)	NULL	—	ISO 18626 protocol version for the partner.

Shared servers use a base table plus per-site views

On a shared (multi-site) server, LenderAddresses is not a base table — it is a per-site view over the LenderAddressesALL base table. The upgrade adds the columns to LenderAddressesALL and then recreates the per-site views so the new columns are exposed through them. This is handled automatically by the update process; no manual action is required.

2. New Transactions.ISO18626Status column

Column	Type	Nullable	Notes
ISO18626Status	nvarchar(50)	NULL	Per-transaction ISO 18626 attention/error indicator. It sits alongside the existing ISOStatus column (used by the legacy ISO ILL protocol). Staff clear it from the ILLiad Client using the ISO Attention button in the Error Clearing group on the Errors ribbon.

3. New ISO18626Status table

A table that stores the ISO 18626 status history for a transaction, keyed newest-first. It is populated by the separate ISO 18626 Manager component (shipped as ILLiadISO18626Setup.msi), not by ILLiad's database or Client code. The Manager processes on a fixed cycle — every 60 seconds by default — and writes status rows as it works through pending updates, so a status change can take up to about a minute to appear. The interval is configurable in the Manager's appsettings.json (Worker:ProcessingIntervalSeconds, valid range 5 seconds to 24 hours).

Column	Type	Nullable	Default	Notes
TransactionNumber	int	NOT NULL	—	The transaction the status belongs to.
Status	nvarchar(100)	NOT NULL	—	The ISO 18626 status value.
Created	datetime2	NOT NULL	GETDATE()	When the status row was written.

Primary key: PK_ISO18626Status, clustered on (TransactionNumber, Created DESC) — so the newest status for a transaction sorts first.

Clearing ISO 18626 attention

The ISO Attention button (Client, Error Clearing group on the Errors ribbon) clears both the legacy ISOStatus and the Transactions.ISO18626Status values in a single action. It is enabled whenever either value is set.

A column and a table share the name "ISO18626Status"

Do not confuse the two objects:

• Transactions.ISO18626Status is a column on the Transactions table, typed nvarchar(50).
• ISO18626Status is a separate table whose Status column is typed nvarchar(100).

They happen to share a name but are unrelated objects.

Upgrade behavior for existing sites

For fresh installs, all of the above (keys, columns, tables, and the VersionISO18626Manager key) are part of the initial database — no special action is needed.

For existing sites, the ISO 18626 schema is delivered as part of the ILLiad 10 update. Key points for administrators and DBAs:

• It is delivered by the standard ILLiad update process. You do not run any SQL by hand; the schema update runs alongside the other ILLiad 10 database updates.
• Every statement is guarded and idempotent. Each column, table, and key is created only if it does not already exist, so the update is a safe no-op on a database that already has the objects (including a re-run).
• The version key is intentionally left unset on upgrade. As noted above, the update does not seed VersionISO18626Manager so that the ISO 18626 Manager component installs correctly. The Manager's own installer stamps the key.

After upgrading

Once the update has run, confirm the rollout by checking that:

1. ISO18626Enabled and the other keys appear under System > ISOILLDefaults in the Customization Manager.
2. The ISO 18626 columns are present on LenderAddresses (via the per-site views on a shared server).
3. VersionISO18626Manager appears under System > Versions after the AutoUpdater has installed the ISO 18626 Manager.

To actually start using ISO 18626, set ISO18626Enabled to Yes and set ISO18626SystemID to your site's identifier, then configure your ISO 18626 partners on the Lender Addresses form.