Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning

Atlas and OCLC do not support default addons or user-created addons.

If you need assistance with using, troubleshooting, or writing addons, please contact Atlas Systems for a custom services quote.


NameBL on Demand
Version1.2
AuthorBritish Library
DescriptionThe BL on Demand addon facilitates ordering materials in ILLiad using the British Library's BL on Demand service. OCLC IFM is used for making payments for the BL on Demand orders.

...

Addon settings are configured in the Manage Addons form (System tab, Manage Addons).

NameTypeDescription
IFMSpendingLimitStringThe maximum amount allowed for an order. This is a numeric value and should not include currency symbols.
BritishLibraryUsernameStringUsername for logging into the British Library. This setting can be left empty but will require logging into manually to complete an order.
BritishLibraryPasswordStringPassword for logging into the British Library. This setting can be left empty but will require logging into manually to complete an order.
BritishLibraryAccountKeyStringThe British Library account key (with the format nn-nnnn [n is any digit]) that the user is wanting to order against. When supplied, the availability and pricing will be specific to that account.
OrderNumberFieldStringThe ILLiad transaction field to store the British Library order number.
OrderCostFieldStringThe ILLiad transaction field to store the British Library cost. Regardless of your CurrencyDisplayFormat, this value is stored in IFM.
CurrencyDisplayFormatString

The currency symbol used to display British Library price ranges. This may not be the same as the IFM charges that are processed.

The available currency formats are based on British Library supported currencies. The allowed values are: USD, GBP, EUR, HKD, CAD, AUD, CHF, DKK, INR, ISK, JPY, NOK, NZD, SEK, SGD, THB, ZAR

PricingRegionStringThe British Library pricing region to indicate which price list is used for display purposes. Valid values are UK or OS (overseas).
DeliveryFormatPreferenceStringA comma-separated list of preferred delivery formats. The addon will attempt to set the selected delivery format based on the first option that is available to an order. The available formats are based on the button names that display in the BL ordering interface such as Encrypted Download, Unencrypted Download, and Paper.
DeliverySpeedPreferenceStringA comma-separated list of preferred delivery speeds. The addon will attempt to set the selected delivery speed based on the first option that is available to an order. The available speed options are based on the button names that display in the BL ordering interface such as 2 Hours, 24 Hours, and 4 Days.
DeliveryQualityPreferenceStringA comma-separated list of preferred delivery qualities. The addon will attempt to set the selected delivery quality based on the first option that is available to an order. The available quality options are based on the button names that display in the BL ordering interface such as Standard and High.
LibraryPrivilegePreferenceBooleanSets the initial state for the 'Library Privilege' option if it is available on the British Library ordering form.
CacheDirectoryStringThe directory to cache data to. If the directory does not exist, the addon will attempt to create it. For this setting, the string "{MyDocuments}" will be replaced with the path to the current user's MyDocuments directory.
DebugEnabledBooleanSpecifies whether additional debug logging should be written to the log file

...

Panel

Example: {MatchXml://result/matches/match/metadata/titleLevel/title}

...