Project

General

Profile

metacat / lib / harvesterConfiguration.xsd @ 1962

1
<?xml version="1.0" encoding="UTF-8"?>
2
<!-- edited with XMLSPY v5 rel. 4 U (http://www.xmlspy.com) by Matt Jones (NCEAS) -->
3
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
4
	<xs:annotation>
5
		<xs:documentation>This module defines the required information for the harvester to collect documents from the local site. The local system containing this document must give the Metacat Harvester read access to this document.	</xs:documentation>
6
	</xs:annotation>
7
	<xs:annotation>
8
		<xs:appinfo>
9
			<tooltip/>
10
			<summary/>
11
			<description/>
12
		</xs:appinfo>
13
	</xs:annotation>
14
	<xs:element name="harvestConfiguration">
15
		<xs:complexType>
16
			<xs:sequence>
17
				<xs:element name="harvestInformation">
18
					<xs:complexType>
19
						<xs:sequence>
20
							<xs:element name="harvesterConfigurationURL" type="xs:anyURI">
21
								<xs:annotation>
22
									<xs:documentation>The URL at which this document can be found in the future.  This URL must have been associated with a DN and authenticated before harvesting will commence.</xs:documentation>
23
								</xs:annotation>
24
							</xs:element>
25
							<xs:element name="ldapDN" type="xs:string">
26
								<xs:annotation>
27
									<xs:documentation>This is the LDAP distinguisged name for the user that should own documents that are harvested.  This DN must have been registered with the system to authenticate use of this account.</xs:documentation>
28
								</xs:annotation>
29
							</xs:element>
30
							<xs:choice>
31
								<xs:element name="dateNextHarvest" type="xs:date">
32
									<xs:annotation>
33
										<xs:documentation>The date that the next harvest should occur.   If this date has already passed, then the next harvest will occur by default in one week from the time of the most recent harvest.</xs:documentation>
34
									</xs:annotation>
35
								</xs:element>
36
								<xs:element name="updateFrequency">
37
									<xs:annotation>
38
										<xs:documentation>The frequency at which harvests should occur.  This is specified as an integrer number of days or weeks from the date of the last harvest.  This is an alternate way of specifying the schedule that does not require updating the configuration document as often, but also is less flexible than specifying dateNextHarvest directly.</xs:documentation>
39
									</xs:annotation>
40
									<xs:complexType>
41
										<xs:simpleContent>
42
											<xs:extension base="xs:integer">
43
												<xs:attribute name="unit" default="day">
44
													<xs:simpleType>
45
														<xs:restriction base="xs:string">
46
															<xs:enumeration value="day"/>
47
															<xs:enumeration value="week"/>
48
														</xs:restriction>
49
													</xs:simpleType>
50
												</xs:attribute>
51
											</xs:extension>
52
										</xs:simpleContent>
53
									</xs:complexType>
54
								</xs:element>
55
							</xs:choice>
56
						</xs:sequence>
57
					</xs:complexType>
58
				</xs:element>
59
				<xs:element name="document" minOccurs="0" maxOccurs="unbounded">
60
					<xs:complexType>
61
						<xs:sequence>
62
							<xs:element name="docid">
63
								<xs:annotation>
64
									<xs:documentation>The complete document identifier to be used by metacat.  The docid is a compound element that gives a scope for the identifier, an integer local identifer that is unique within that scope, and a revision.  Each revision is assumed to specify a unique, non-changing document, so once a particular revision is harvested, there is no need for it to be harvested again.  To trigger a harvest of a document that has been updated, increment the revision number for that identifier.
65
									</xs:documentation>
66
								</xs:annotation>
67
								<xs:complexType>
68
									<xs:sequence>
69
										<xs:element name="scope" type="xs:string">
70
											<xs:annotation>
71
												<xs:documentation>
72
													The system prefix of a metacat docid that defines the scope within which the identifier is unique.																</xs:documentation>
73
											</xs:annotation>
74
										</xs:element>
75
										<xs:element name="identifier" type="xs:long">
76
											<xs:annotation>
77
												<xs:documentation>
78
													The local (site specific) portion of the identifier (docid) that is unique within the context of the scope.
79
												</xs:documentation>
80
											</xs:annotation>
81
										</xs:element>
82
										<xs:element name="revision" type="xs:string">
83
											<xs:annotation>
84
												<xs:documentation>The revision identifier for this document, indicating a unique document version.
85
												</xs:documentation>
86
											</xs:annotation>
87
										</xs:element>
88
									</xs:sequence>
89
								</xs:complexType>
90
							</xs:element>
91
							<xs:element name="documentType" type="xs:string">
92
								<xs:annotation>
93
									<xs:documentation>
94
										The  type of dodument to be harvested, indicated by a namespace string, formal public identifier, mime type, or other type indicator.											</xs:documentation>
95
								</xs:annotation>
96
							</xs:element>
97
							<xs:element name="documentURL" type="xs:anyURI">
98
								<xs:annotation>
99
									<xs:documentation>
100
										The documentURL field contains the URL of the document to be harvested. The Metacat harvester must be given read access to the contents at this URL.
101
									</xs:documentation>
102
								</xs:annotation>
103
							</xs:element>
104
						</xs:sequence>
105
					</xs:complexType>
106
				</xs:element>
107
			</xs:sequence>
108
		</xs:complexType>
109
	</xs:element>
110
</xs:schema>