Interlibrary Loan Protocol Implementors Group (IPIG)
Directory Services for Interlibrary Loan – Information Model Diagrams
Version 1.0
3 August 2002
Directory Services for Interlibrary Loan
The most current versions of this and related documents in the IPIG Profile suite are available on the Interlibrary Loan Application Standards Maintenance Agency web site at:
<
1
Version 1.0/ 3 August 2002
ILL Policy Directory
Table of Contents
1Scope
2Occurrence Symbols:
3ILL Processing Unit
3.1UnitName
3.2UnitStatus
3.3ScopeNotes
3.4SymbolCodes
3.5ContactInformation
3.6Affiliations
3.7InfoPointers
3.8UnitDescriptors
3.9ILLService
3.9.1ILLServicesSupported
3.9.2ILLServiceTimes
3.9.3ILLProtocolInformation
3.9.4ILLRequestsAcceptedFrom
3.9.5ILLServiceDescriptions
3.9.6ILLServicePolicies
3.9.6.1LoanPolicy
3.9.6.2CopyPolicy
3.9.6.3LocationsPolicy
3.9.6.4EstimatesPolicy
3.9.6.5ResponderSpecificServicePolicy
3.9.7ILLServiceCharges
3.9.8ILLPolicyMatrix
3.10Notes
3.11Common Data Objects
3.11.1Any
3.11.2BillingMethod
3.11.3ContactDetails
3.11.4CopyMethodAndMedium
3.11.5DeliveryMethod
3.11.6Exclude
3.11.7MediumType
3.11.8PaymentMethod
3.11.9RequestMethod
3.11.10SeqLangString
4Data Types
1
Version 1.0/ 3 August 2002
ILL Policy Directory
1Scope
This document contains the graphical information models for the ILLPolicy Directory.
2Occurrence Symbols:
none / The element must appear once and only once. / MinOccurs=1 / MaxOccurs=1? / The element (or group of elements) may appear zero or one times. The element is optional, but is only allowed to appear once. / MinOccurs=0 / MaxOccurs=1.
+ / The element (or group of elements) must appear one or more times. The element is required to appear at least once, but multiple consecutive occurrences may be present. / MinOccurs=1 / MaxOccurs=*
* / The element (or group of elements) may appear zero or more times. The element can appear as many times consecutively as needed, or even zero times. / MinOccurs=0 / MaxOccurs=*
.
{} / The element (or group of elements) must appear within the specified range. / Set occurrence range / Set occurrence range.
3ILL Processing Unit
No / Name / Req / Mult1 / UnitName / M / 1
2 / UnitStatus / M / 1
3 / ScopeNotes / O / 0-1
4 / SymbolCodes / M / 1
5 / ContactInformation / M / 1
6 / Affiliations / O / 0-1
7 / InfoPointers / O / 0-1
8 / UnitDescriptors / M / 1
9 / ILLService / M / 1
10 / Notes / O / 0-1
3.1UnitName
3.2UnitStatus
3.3ScopeNotes
3.4SymbolCodes
3.5ContactInformation
(See Contact Details for full expansion of addresses)
3.6Affiliations
3.7InfoPointers
3.8UnitDescriptors
3.9ILLService
3.9.1ILLServicesSupported
3.9.2ILLServiceTimes
3.9.3ILLProtocolInformation
(Notes:
IS2022characterSet string with values from the INTERNATIONAL REGISTER OF CODED CHARACTER SETS TO BE USED WITH ESCAPE SEQUENCES (
ISO2022RegisteredEscSequencecorresponding escape sequence (for C0/G0 and excluding the escape character) from the Register.
3.9.4ILLRequestsAcceptedFrom
3.9.5ILLServiceDescriptions
(See Common Data Objects for full expansion of method objects)
3.9.6ILLServicePolicies
3.9.6.1LoanPolicy
3.9.6.2CopyPolicy
3.9.6.3LocationsPolicy
3.9.6.4EstimatesPolicy
3.9.6.5ResponderSpecificServicePolicy
3.9.7ILLServiceCharges
(See Common Data Objects for full expansion of Charge Description objects)
3.9.8ILLPolicyMatrix
3.10Notes
3.11Common Data Objects
3.11.1Any
3.11.2BillingMethod
3.11.3ContactDetails
The context of the address must be able to be discovered unambiguously. Eg distinguished by Physical Address Types or by dates that are different.
3.11.4CopyMethodAndMedium
3.11.5DeliveryMethod
3.11.6Exclude
3.11.7MediumType
3.11.8PaymentMethod
3.11.9RequestMethod
3.11.10SeqLangString
4Data Types
The data types are presented here in alphabetical order
Name:boolean
Definition:Supports the mathematical concept of binary-logic, having a value of either TRUE or FALSE.
Example Data Element:ILLActiveStatus
Name:DateTime
Definition:DateTime epresents a specific instant in time. The value space of dateTime is the space of the combinations of date and time of day from Section 5.4 of ISO 8601.
Representation: A single lexical representation, which is a subset of the lexical representations defined by ISO 8601, is allowed. This lexical representation is the ISO 8601 extended format CCYY-MM-DDThh:mm:ss.sss where “CC” represents the century , “YY” the year, “MM” the month, and “DD” the day, preceded by an optional leading sign to indicate a negative number. If the sign is omitted, “+” is assumed. The letter “T” is the date/time separator, and “hh”, “mm” and “ss.sss” represent hour, minute, and second respectively. Additional digits may be used to increase the precision of fractional seconds if desired. To accommodate year values greater than 9999 additional digits may be added to the left of this representation. The year 0000 is prohibited.
This representation MUST be followed immediately by a “Z” to indicate Coordinated Universal Time (UTC). To indicate a specific time zone, i.e., the difference between local time and Coordinated Universal Time, the difference immediately follows the time and consists of a sign (“+” or “-”) followed by hh:mm.
Example Usage:2000-06-15T11:30Z
2000-11-10T12:20:30.1Z-05:00
2000-09-14T18:49:12.061Z+02:00
Example Data Element:ValidTo
Name:Day
Definition:Day represents a day of the week. The value space of day is the day of the week from Section 5.2.3 of ISO 8601.
Lexical Representation: Day of the week is represented by one decimal digit. Monday shall be defined as day [1] of any calendar week, and subsequent days of the same week shall be numbered in ascending sequence to Sunday (day [7])
Example Usage:5
Example Data Element:DayofWeek
Name: Decimal
Definition:Decimal represents arbitrary precision decimal numbers. The ·value space· of decimal is the set of the values i × 10^-n, where i and n are integers such that n >= 0. The ·order-relation· on decimal is: x < y iff y - x is positive.
Representation:Decimal has a lexical representation consisting of a finite-length sequence of decimal digits (#x30-#x39) separated by a period as a decimal indicator. An optional leading sign is allowed. If the sign is omitted, "+" is assumed. Leading and trailing zeroes are optional. If the fractional part is zero, the period and following zero(es) can be omitted.
Example Usage:0.5
+4
Example Data Element:IncrementQuantity
Name:Empty
Definition:An element that contains no data and indicates, by its presence or absence, a predefined condition or situation. For example, the empty element NoServiceOffered in ILLServices indicates that this ILL Procesing Unit does not provide any ILL services.
Example Data Element:Any
Name:MimeType
Definition:A valid vaue from the XXX IANA registration authority and its extensions (eg x-gedi)
Example Usage:tiff
jpeg
Example Data Element:FileType
Name:PositiveInteger
Definition:PositiveInteger is an integer whose minimum value is a positive 1. The value space of positiveInteger is the infinite set of positive numbers {1,2,3,…}.
Example Usage:15
200
Example Data Element:PreferenceSequenceNo
Name:String
Definition:a string of letters, numbers, and punctuation, without any predefined properties for the processing of the data
Example Usage:library
money
Smith
Example Data Element:Surname
Name:Time
Definition:Time represents an instant of time that recurs every day. The ·value space· of time is the space of time of day values as defined in Section 5.3 of ISO8601. Specifically, it is a set of zero-duration daily time instances.
Representation:The lexical representation for time is the left truncated lexical representation for dateTime: hh:mm:ss.sss. This representation MUST be followed immediately by a “Z” to indicate Coordinated Universal Time (UTC). To indicate a specific time zone, i.e., the difference between local time and Coordinated Universal Time, the difference immediately follows the time and consists of a sign (“+” or “-”) followed by hh:mm.
Example Usage:13:20:00Z-05:00
18:49:12Z+02:00
Example Data Element:ServiceHoursStartTime
Name:uriReference
Definition:uriReference represents a Uniform Resource Identifier Reference (URI). This type should be used to specify the intention that the value fulfills the role of a URI as defined by [RFC 2396], as amended by [RFC 2732].
Representation:The ·lexical space· of anyURI is finite-length character sequences which are legal URIs according to [RFC 2396], as amended by [RFC 2732]. NOTE: Spaces are, in principle, allowed in the ·lexical space· of anyURI, however, their use is highly discouraged (unless they are encoded by %20).
Example Usage:
Example Data Element:URI
1
Version 1.0/ 3 August 2002