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

Document Delivery URL Field

ILLiad 10 adds a Document Delivery URL field to the transaction. It was added for ISO 18626 delivery: it gives you a place to store the link to a delivered document — such as an ISO 18626 tokenized retrieval URL — so that link travels with the request and can be reused in your notifications and printouts. For the interlibrary loan messaging standard it supports, see ISO 18626.

The field itself is a general, plain-text transaction field. Although it was built for ISO 18626, ILLiad does not restrict what you put in it: staff or an integration store a document-delivery link, and you surface it where it's useful. ILLiad does not fill the field in for you and does not act on its contents.

Where the field appears

Document Delivery URL is available on the request in the ILLiad client:

  • On the Request detail form, where you can view and edit it.
  • On the Check In From Library form (borrowing), where you can view and edit it.
  • On the Borrowing Pipeline Review form (Decision Support), where it is shown read-only for reference.

You can also add Document Delivery URL as a column when printing transaction lists.

Populated by staff or by an integration

The field is empty unless something sets it — either a staff member typing a URL into it, or an external system writing to it through the ILLiad API. No ILLiad process populates it automatically.

Using it in email and print templates

Because it's a standard transaction field, you can include the Document Delivery URL in your notification and print templates with the tag:

<#Transaction.DocumentDeliveryURL>

When a notification or printout is generated, ILLiad replaces that tag with the value stored on the transaction. This lets you, for example, include a retrieval link in a "your document is ready" email when your workflow populates the field.

Setting it through the API

Applications that create or update transactions through the ILLiad (Connect) API can set DocumentDeliveryURL on the transaction like any other field, which is useful if an external delivery system needs to record where it placed a document.