Download 3 ILL Processing Unit

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:
< http://www.nlc-bnc.ca/iso/ill/>
Version 1.0/ 3 August 2002
2
ILL Policy Directory
TABLE OF CONTENTS
1
SCOPE.......................................................................................................................................................................................... 1
2
OCCURRENCE SYMBOLS: ..................................................................................................................................................... 1
3
ILL PROCESSING UNIT .......................................................................................................................................................... 2
3.1
UNITNAME ............................................................................................................................................................................ 3
3.2
UNITSTATUS .......................................................................................................................................................................... 3
3.3
SCOPENOTES ......................................................................................................................................................................... 3
3.4
SYMBOLCODES ...................................................................................................................................................................... 4
3.5
CONTACTINFORMATION ......................................................................................................................................................... 4
3.6
AFFILIATIONS......................................................................................................................................................................... 5
3.7
INFOPOINTERS ....................................................................................................................................................................... 5
3.8
UNITDESCRIPTORS ................................................................................................................................................................. 5
3.9
ILLSERVICE........................................................................................................................................................................... 6
3.9.1
ILLServicesSupported .................................................................................................................................................. 6
3.9.2
ILLServiceTimes .......................................................................................................................................................... 7
3.9.3
ILLProtocolInformation ............................................................................................................................................... 8
3.9.4
ILLRequestsAcceptedFrom .......................................................................................................................................... 9
3.9.5
ILLServiceDescriptions .............................................................................................................................................. 10
3.9.6
ILLServicePolicies ..................................................................................................................................................... 11
3.9.6.1
LoanPolicy............................................................................................................................................................. 12
3.9.6.2
CopyPolicy ............................................................................................................................................................ 13
3.9.6.3
LocationsPolicy ..................................................................................................................................................... 14
3.9.6.4
EstimatesPolicy ..................................................................................................................................................... 15
3.9.6.5
ResponderSpecificServicePolicy ........................................................................................................................... 16
3.9.7
ILLServiceCharges .................................................................................................................................................... 17
3.9.8
ILLPolicyMatrix......................................................................................................................................................... 18
3.10
NOTES ................................................................................................................................................................................. 18
3.11
COMMON DATA OBJECTS .................................................................................................................................................... 19
3.11.1
Any ............................................................................................................................................................................. 19
3.11.2
BillingMethod ............................................................................................................................................................ 19
3.11.3
ContactDetails ........................................................................................................................................................... 20
3.11.4
CopyMethodAndMedium ........................................................................................................................................... 21
3.11.5
DeliveryMethod.......................................................................................................................................................... 21
3.11.6
Exclude ...................................................................................................................................................................... 21
3.11.7
MediumType............................................................................................................................................................... 22
3.11.8
PaymentMethod ......................................................................................................................................................... 22
3.11.9
RequestMethod........................................................................................................................................................... 22
3.11.10 SeqLangString ............................................................................................................................................................ 23
4
DATA TYPES ............................................................................................................................................................................ 24
Version 1.0/ 3 August 2002
i
1
Scope
This document contains the graphical information models for the ILLPolicy Directory.
2
Occurrence 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.
Version 1.0/3 August 2002
.
Set occurrence range
Set occurrence range.
1
ILL Policy Directory
3
ILL Processing Unit
No
Name
Req
Mult
1
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
Version 1.0/ 3 August 2002
2
ILL Policy Directory
3.1
UnitName
3.2
UnitStatus
3.3
ScopeNotes
Version 1.0/ 3 August 2002
3
ILL Policy Directory
3.4
SymbolCodes
3.5
ContactInformation
Version 1.0/ 3 August 2002
4
ILL Policy Directory
(See Contact Details for full expansion of addresses)
3.6
Affiliations
3.7
InfoPointers
3.8
UnitDescriptors
Version 1.0/ 3 August 2002
5
ILL Policy Directory
3.9
3.9.1
ILLService
ILLServicesSupported
Version 1.0/ 3 August 2002
6
ILL Policy Directory
3.9.2
ILLServiceTimes
Version 1.0/ 3 August 2002
7
ILL Policy Directory
3.9.3
ILLProtocolInformation
(Notes:
IS2022characterSet string with values from the INTERNATIONAL REGISTER OF CODED CHARACTER SETS TO BE USED
WITH ESCAPE SEQUENCES (http://www.itscj.ipsj.or.jp/ISO-IR/)
ISO2022RegisteredEscSequencecorresponding escape sequence (for C0/G0 and excluding the escape character) from the Register.
Version 1.0/ 3 August 2002
8
ILL Policy Directory
3.9.4
ILLRequestsAcceptedFrom
Version 1.0/ 3 August 2002
9
ILL Policy Directory
3.9.5
ILLServiceDescriptions
(See Common Data Objects for full expansion of method objects)
Version 1.0/ 3 August 2002
10
ILL Policy Directory
3.9.6
ILLServicePolicies
Version 1.0/ 3 August 2002
11
ILL Policy Directory
3.9.6.1
LoanPolicy
Version 1.0/ 3 August 2002
12
ILL Policy Directory
3.9.6.2
CopyPolicy
Version 1.0/ 3 August 2002
13
ILL Policy Directory
3.9.6.3
LocationsPolicy
Version 1.0/ 3 August 2002
14
ILL Policy Directory
3.9.6.4
EstimatesPolicy
Version 1.0/ 3 August 2002
15
ILL Policy Directory
3.9.6.5
ResponderSpecificServicePolicy
Version 1.0/ 3 August 2002
16
ILL Policy Directory
3.9.7
ILLServiceCharges
(See Common Data Objects for full expansion of Charge Description objects)
Version 1.0/ 3 August 2002
17
ILL Policy Directory
3.9.8
ILLPolicyMatrix
3.10 Notes
Version 1.0/ 3 August 2002
18
ILL Policy Directory
3.11 Common Data Objects
3.11.1
Any
3.11.2
BillingMethod
Version 1.0/ 3 August 2002
19
ILL Policy Directory
3.11.3
ContactDetails
The context of the address must be able to be discovered unambiguously. Eg distinguished by Physical Address Types or by dates
that are different.
Version 1.0/ 3 August 2002
20
ILL Policy Directory
3.11.4
CopyMethodAndMedium
3.11.5
DeliveryMethod
3.11.6
Exclude
Version 1.0/ 3 August 2002
21
ILL Policy Directory
3.11.7
MediumType
3.11.8
PaymentMethod
3.11.9
RequestMethod
Version 1.0/ 3 August 2002
22
ILL Policy Directory
3.11.10 SeqLangString
Version 1.0/ 3 August 2002
23
ILL Policy Directory
4
Data Types
The data types are presented here in alphabetical order
Name:
Definition:
Example Data Element:
boolean
Supports the mathematical concept of binary-logic, having a value of either TRUE or FALSE.
ILLActiveStatus
Name:
Definition:
DateTime
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:
Example Data Element:
2000-06-15T11:30Z
2000-11-10T12:20:30.1Z-05:00
2000-09-14T18:49:12.061Z+02:00
ValidTo
Name:
Definition:
Day
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:
Example Data Element:
5
DayofWeek
Name:
Definition:
Decimal
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
IncrementQuantity
Example Data Element:
Version 1.0/ 3 August 2002
24
ILL Policy Directory
Name:
Definition:
Example Data Element:
Name:
Definition:
Example Usage:
Example Data Element:
Name:
Definition:
Empty
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.
Any
MimeType
A valid vaue from the XXX IANA registration authority and its extensions (eg x-gedi)
tiff
jpeg
FileType
Example Data Element:
PositiveInteger
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,…}.
15
200
PreferenceSequenceNo
Name:
String
Definition:
a string of letters, numbers, and punctuation, without any predefined properties for the processing of
the data
library
money
Smith
Surname
Example Usage:
Example Usage:
Example Data Element:
Name:
Definition:
Representation:
Example Usage:
Example Data Element:
Time
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.
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.
13:20:00Z-05:00
18:49:12Z+02:00
ServiceHoursStartTime
Name:
Definition:
uriReference
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).
http://www.nlc-bnc.ca/iso/ill/main.htm
http://www.nla.gov.au
URI
Example Usage:
Example Data Element:
Version 1.0/ 3 August 2002
25