Project

General

Profile

« Previous | Next » 

Revision 6989

Added by Matt Jones about 12 years ago

Updated configuration documentation in admin guide for Metacat DataONE section. Changed links in configuration utility to point at the Admin guide.

View differences:

lib/admin/admin.js
125 125
}
126 126

  
127 127
function helpWindow(context, helpFile) {
128
	fileLoc = context + "/docs/user/" + helpFile;
129
	window.open(fileLoc,'mywindow','width=750,height=200,scrollbars=yes,location=no,status=no');
128
	fileLoc = context + "/" + helpFile;
129
	window.open(fileLoc,'mywindow','width=1050,height=800,scrollbars=yes,location=no,status=no');
130 130
}
131 131

  
132 132

  
lib/admin/dataone-configuration.jsp
80 80
	
81 81
	<div class="form-row">
82 82
		<img class="question-mark" src="style/images/question-mark.gif" 
83
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
83
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
84 84
		<div class="textinput-label">
85 85
			<label for="dataone.nodeName" title="A short, human-readable name for this node">Node Name</label>
86 86
		</div>
......
91 91
	</div>
92 92
	<div class="form-row">
93 93
		<img class="question-mark" src="style/images/question-mark.gif" 
94
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
94
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
95 95
		<div class="textinput-label">
96 96
			<label for="dataone.nodeDescription" title="A brief description of the node and its holdings">Node Description</label>
97 97
		</div>
......
102 102
	</div>
103 103
	<div class="form-row">
104 104
		<img class="question-mark" src="style/images/question-mark.gif" 
105
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
105
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
106 106
		<div class="textinput-label">
107 107
			<label for="dataone.memberNodeId" title="The DataONE-assigned unique identifier for this node">Node Identifier</label>
108 108
		</div>
......
113 113
	</div>
114 114
	<div class="form-row">
115 115
		<img class="question-mark" src="style/images/question-mark.gif" 
116
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
116
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
117 117
		<div class="textinput-label">
118 118
			<label for="dataone.subject" title="The account in Distinguished Name (DN) format that represents this node in all service interactions">Node Subject</label>
119 119
		</div>
......
124 124
	</div>
125 125
	<div class="form-row">
126 126
		<img class="question-mark" src="style/images/question-mark.gif" 
127
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
127
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
128 128
		<div class="textinput-label">
129 129
			<label for="dataone.contactSubject" title="A verified account in DN format to be used as the primary node contact for this node">Contact Subject</label>
130 130
		</div>
......
135 135
	</div>
136 136
	<div class="form-row">
137 137
		<img class="question-mark" src="style/images/question-mark.gif" 
138
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
138
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
139 139
		<div class="textinput-label">
140 140
			<label for="D1Client.certificate.file" title="The absolute path to the X.509 certificate used to authenticate this node">Node Certificate Path</label>
141 141
		</div>
......
146 146
	</div>
147 147
	<div class="form-row">
148 148
		<img class="question-mark" src="style/images/question-mark.gif" 
149
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
149
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
150 150
		<div class="textinput-label"><label for="dataone.nodeSynchronize" title="Enable DataONE services by synchronizing metadata">Enable DataONE Services</label></div>
151 151

  
152 152
		<%
......
181 181
	<hr class="config-line">
182 182
	<div class="form-row">
183 183
		<img class="question-mark" src="style/images/question-mark.gif" 
184
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
184
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
185 185
		<div class="textinput-label">
186 186
			<label for="dataone.nodeSynchronization.schedule.year" title="Year">Year</label>
187 187
		</div>
......
192 192
	</div>
193 193
	<div class="form-row">
194 194
		<img class="question-mark" src="style/images/question-mark.gif" 
195
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
195
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
196 196
		<div class="textinput-label">
197 197
			<label for="dataone.nodeSynchronization.schedule.mon" title="Month">Month</label>
198 198
		</div>
......
203 203
	</div>
204 204
	<div class="form-row">
205 205
		<img class="question-mark" src="style/images/question-mark.gif" 
206
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
206
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
207 207
		<div class="textinput-label">
208 208
			<label for="dataone.nodeSynchronization.schedule.mday" title="Day of Month">Day of Month</label>
209 209
		</div>
......
214 214
	</div>
215 215
	<div class="form-row">
216 216
		<img class="question-mark" src="style/images/question-mark.gif" 
217
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
217
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
218 218
		<div class="textinput-label">
219 219
			<label for="dataone.nodeSynchronization.schedule.wday" title="Day of Week">Day of Week</label>
220 220
		</div>
......
225 225
	</div>
226 226
	<div class="form-row">
227 227
		<img class="question-mark" src="style/images/question-mark.gif" 
228
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
228
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
229 229
		<div class="textinput-label">
230 230
			<label for="dataone.nodeSynchronization.schedule.hour" title="Hours">Hours</label>
231 231
		</div>
......
236 236
	</div>
237 237
	<div class="form-row">
238 238
		<img class="question-mark" src="style/images/question-mark.gif" 
239
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
239
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
240 240
		<div class="textinput-label">
241 241
			<label for="dataone.nodeSynchronization.schedule.min" title="Minutes">Minutes</label>
242 242
		</div>
......
247 247
	</div>
248 248
	<div class="form-row">
249 249
		<img class="question-mark" src="style/images/question-mark.gif" 
250
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
250
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
251 251
		<div class="textinput-label">
252 252
			<label for="dataone.nodeSynchronization.schedule.sec" title="Seconds">Seconds</label>
253 253
		</div>
......
264 264
	<hr class="config-line">
265 265
	<div class="form-row">
266 266
		<img class="question-mark" src="style/images/question-mark.gif" 
267
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
267
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
268 268
		<div class="textinput-label"><label for="dataone.nodeReplicate" title="Store replicas from other Member Nodes">Accept and Store Replicas</label></div>
269 269

  
270 270
		<%
......
294 294

  
295 295
 	<div class="form-row">
296 296
		<img class="question-mark" src="style/images/question-mark.gif" 
297
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
297
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
298 298
		<div class="textinput-label">
299 299
			<label for="dataone.replicationpolicy.default.numreplicas" title="Default Number of Replicas to be created for local objects">Default Number of Replicas</label>
300 300
		</div>
......
305 305
	</div>
306 306
  	<div class="form-row">
307 307
		<img class="question-mark" src="style/images/question-mark.gif" 
308
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
308
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
309 309
		<div class="textinput-label">
310 310
			<label for="dataone.replicationpolicy.default.preferredNodeList" title="A comma-separated list of preferred nodes to house replicas">Default Preferred Nodes</label>
311 311
		</div>
......
316 316
	</div>
317 317
   	<div class="form-row">
318 318
		<img class="question-mark" src="style/images/question-mark.gif" 
319
			onClick="helpWindow('<%= request.getContextPath() %>','metacat-configure.html#dataone')"/>
319
			onClick="helpWindow('<%= request.getContextPath() %>','docs/dataone.html#configuring-metacat-as-a-member-node')"/>
320 320
		<div class="textinput-label">
321 321
			<label for="dataone.replicationpolicy.default.blockedNodeList" title="A comma-separated list of blocked nodes never to house replicas">Default Blocked Nodes</label>
322 322
		</div>
docs/user/metacat/source/dataone.rst
158 158
registers with the DataONE Coordinating Nodes (when you click 'Register' at the
159 159
bottom of this form), the Node Identifier is automatically set.  **It is critical that
160 160
you not change the Node Identifier**, as that will break the connection with the
161
DataONE network.  The ability to edit this field is only provided for the rare case
161
DataONE network.  Changing this field should only happen in the rare case
162 162
in which a new Metacat instance is being established to act as the provider for an 
163 163
existing DataONE Member Node, in which case the field can be edited to set it to
164 164
the value of a valid, existing Node Identifier.
......
167 167
proper operation of the node.  To act as a Member Node in DataONE, you must obtain
168 168
an X.509 certificate that can be used to identify this node and allow it to securely
169 169
communicate using SSL with other nodes and client applications.  This certificate can 
170
either be obtained from the DataONE Certificate Authority, or from a commercial 
171
provider of certificates. Once you have the certificate in hand, use a tool such 
170
be obtained from the DataONE Certificate Authority. 
171
Once you have the certificate in hand, use a tool such 
172 172
as ``openssl`` to determine the exact subject distinguished name in the 
173 173
certificate, and use that to set the Node Subject field.  Set the Node 
174 174
Certificate Path to the location on the system in which you stored the 
175
certificate file.
175
certificate file. Be sure to protect the certificate file, as it contains the
176
private key that is used to authenticate this node within DataONE.
176 177

  
177
The ``Synchronize`` checkbox allows the administrator to decide whether to turn on
178
synchronization with the DataONE network.  When this box is unchecked, the DataONE
179
Coordinating Nodes will not attempt to synchronize at all, but when checked, then
180
DataONE will periodically contact the node to synchrnize all metadata content.
178
The ``Enable DataONE Services`` checkbox allows the administrator to decide whether to 
179
turn on synchronization with the DataONE network.  When this box is unchecked, the 
180
DataONE Coordinating Nodes will not attempt to synchronize at all, but when checked, 
181
then DataONE will periodically contact the node to synchrnize all metadata content.
181 182
To be part of the DataONE network, this box must be checked as that allows 
182 183
DataONE to receive a copy of the metadata associated with each object in the Metacat
183 184
system.  The switch is provided for those rare cases when a node needs to be disconnected
......
191 192
hour (such as ``11``) and the ``Minutes`` field to a concrete value like``15``, 
192 193
which would change the schedule to synchronize at 11:15 am daily.  
193 194

  
195
The Replication section is used to configure replication options for the node
196
overall and for objects stored in Metacat.  The ``Accept and Store Replicas``
197
checkbox is used to indicate that the administrator of this node is willing to allow
198
replica data and metadata from other Member Nodes to be stored on this node.  We
199
encourage people to allow replication to their nodes, as this increases the
200
scalability and flexibility of the network overall.  The three "Default" fields set
201
the default values for the replication policies for data and metadata on this node
202
that are generated when System Metadata is not available for an object (such as when
203
it originates from a client that is not DataONE compliant).  The ``Default Number of
204
Replicas`` determines how many replica copies of the object should be stored on
205
other Member Nodes.  A value of 0 or less indicates that no replicas should be
206
stored.  In addition, you can specify a list of nodes that are either preferred for
207
use when choosing replica nodes, or that are blocked from use as replica nodes.
208
This allows Member Nodes to set up bidirectional agreements with partner nodes to
209
replicate data across their sites. The values for both ``Default Preferred Nodes``
210
and ``Default Blocked Nodes`` is a comma-separated list of NodeReference identifiers 
211
that were assigned to the target nodes by DataONE.
212

  
194 213
Once these parameters have been properly set, us the ``Register`` button to
195 214
request to register with the DataONE Coordinating Node.  This will generate a
196 215
registration document describing this Metacat instance and send it to the 

Also available in: Unified diff