Project

General

Profile

1 878 berkley
<!--
2
  * properties.html
3
  *
4
  *      Authors: Chad Berkley
5 4243 daigle
  *    Copyright: 2008 Regents of the University of California and the
6 878 berkley
  *               National Center for Ecological Analysis and Synthesis
7
  *  For Details: http://www.nceas.ucsb.edu/
8
  *      Created: 2001 January 23
9
  *      Version:
10
  *    File Info: '$ '
11
  *
12
  *
13
-->
14
<HTML>
15
<HEAD>
16 4169 daigle
<TITLE>Metacat Properties Files</TITLE>
17 3780 daigle
<link rel="stylesheet" type="text/css" href="./default.css">
18 878 berkley
</HEAD>
19
<BODY>
20
  <table width="100%">
21
    <tr>
22
      <td class="tablehead" colspan="2"><p class="label">Metacat Properties File</p></td>
23
      <td class="tablehead" colspan="2" align="right">
24
        <a href="./datafiles.html">Back</a> | <a href="./metacattour.html">Home</a> |
25 2131 costa
        <a href="./harvester.html">Next</a>
26 878 berkley
      </td>
27
    </tr>
28
  </table>
29 4169 daigle
  <p> Metacat Server has properties that are stored in two general locations.
30
     Global properties are held in:
31
     <p class="indent"><em>&lt;CONTEXT_DIR&gt;*/WEB_INF/metacat.properties</em>.</p>
32
     Skin specific properties are set on a per-skin basis in:
33
     <p class="indent"><em>&lt;CONTEXT_DIR&gt;*/WEB_INF/style/skins/&lt;SKIN_NAME&gt;/&lt;SKIN_NAME&gt;.properties</em></p>
34
  </p>
35
36
  <p>
37
     The most dynamic properties are modified using the internal <a href="./metacatconfigure.html">Metacat configuration utility </a>.
38
     However, it may be necessary to manually edit a configuration file to update more static values.
39
  </p>
40
41
  <p>
42
     The list of properties shown on this page gives the following information about each property:
43
     <ul>
44
       <li> <b>Property Name</b> - the header for each section is the name of the
45
         property as it appears in the property file.</li>
46
       <li> <b>Default Value</b> - the default value set for that property if any. </li>
47
       <li> <b>Description</b> - what does the property control and how can it be set. </li>
48
       <li> <b>Set Method</b> - how does the value get set in the properties file.  There are
49
         two options:
50
         <ul>
51
           <li> Configuration Utility - the value is set via the internal <a href="./metacatconfigure.html">Metacat configuration utility </a></li>
52
           <li> Manually - the value is set to a default that can only be changed by manually editing the configuration file. </li>
53
         </ul>
54
       <li> <b>Example</b> - an example setting for the property.</li>
55
     </ul>
56 3591 costa
  </p>
57 4169 daigle
58
  <p class="footnote">
59
     (* CONTEXT_DIR refers to the directory where the Metacat application code
60
     lives.  This is a combination of the web application directory and the
61
     metacat context directory.  This usually looks something like
62
     /usr/local/tomcat/webapps/knb.  However, your webapps directory could
63
     be somewhere besides the tomcat directory and your context could be
64
     something other than knb.)
65
  </p>
66
67 4246 daigle
  <h1>Index</h1>
68
  <div class="index-header"><a href="#GlobalMetacatProperties">Global Metacat Properties</a></div>
69
    <div class="index-entry"><a href="#server.name">Server Values</a></div>
70
    <div class="index-entry"><a href="#application.metacatVersion">Application Values</a></div>
71
    <div class="index-entry"><a href="#database.connectionURI">Database Values</a></div>
72
    <div class="index-entry"><a href="#auth.class">Authorization Values</a></div>
73 4579 daigle
    <div class="index-entry"><a href="#auth.administrators">Authentication Values</a></div>
74 4246 daigle
    <div class="index-entry"><a href="#xml.saxparser">XML/EML Values</a></div>
75
76
  <a name="GlobalMetacatProperties"></a><h1>Global Metacat Properties - (metacat.properties) </h1>
77 4169 daigle
  <hr>
78
79
  <a name="server.name"></a><h1 class="property-main"> server.name </h1>
80
  <div class="property-description-line">
81
    <h2 class="property-inline"> Default Value: </h2>
82
    <p class="property-text">localhost</p>
83
  </div>
84
  <div class="property-description-line">
85
    <h2 class="property-inline"> Set Method: </h2>
86
    <p class="property-text">Configuration Utility</p>
87
  </div>
88
  <div class="property-description-line">
89
    <h2 class="property-inline"> Description: </h2>
90
    <p class="property-text">The network host name that will be
91
      used to access Metacat.  Note that this is not necessarily the physical
92
      name of the server running Metacat.  The host name should not include
93
      the protocol prefix (http://).</p>
94
  </div>
95
  <div class="property-description-line">
96
    <h2 class="property-inline"> Example: </h2>
97
    <p class="property-text">knb.ecoinformatics.org</p>
98
  </div>
99
100
  <a name="server.httpPort"></a><h1 class="property-main"> server.httpPort </h1>
101
  <div class="property-description-line">
102
    <h2 class="property-inline"> Default Value: </h2>
103
    <p class="property-text">80</p>
104
  </div>
105
  <div class="property-description-line">
106
    <h2 class="property-inline"> Set Method: </h2>
107
    <p class="property-text">Configuration Utility</p>
108
  </div>
109
  <div class="property-description-line">
110
    <h2 class="property-inline"> Description: </h2>
111
    <p class="property-text">The network port that will be
112
      used to access Metacat for non-secure (standard) connections.
113
      This is usually 80 if Apache web server is running (typical install), and
114
      8080 if Tomcat is running alone, but both Apache and Tomcat could
115
      have been configured to listen on alternate ports. </p>
116
  </div>
117
  <div class="property-description-line">
118
    <h2 class="property-inline"> Example: </h2>
119
    <p class="property-text">80</p>
120
  </div>
121
122
  <a name="server.httpSSLPort"></a><h1 class="property-main"> server.httpSSLPort </h1>
123
  <div class="property-description-line">
124
    <h2 class="property-inline"> Default Value: </h2>
125
    <p class="property-text">443</p>
126
  </div>
127
  <div class="property-description-line">
128
    <h2 class="property-inline"> Set Method: </h2>
129
    <p class="property-text">Configuration Utility</p>
130
  </div>
131
  <div class="property-description-line">
132
    <h2 class="property-inline"> Description: </h2>
133
    <p class="property-text">The network port that will be
134
      used to access Metacat for secure connections.
135
      This is usually 443 if Apache web server is running (typical install), and
136
      8443 if Tomcat is running alone, but both Apache and Tomcat could
137
      have been configured to listen on alternate ports. </p>
138
  </div>
139
  <div class="property-description-line">
140
    <h2 class="property-inline"> Example: </h2>
141
    <p class="property-text">443</p>
142
  </div>
143
144
  <br>
145
146
  <a name="application.metacatVersion"></a><h1 class="property-main"> application.metacatVersion </h1>
147
  <div class="property-description-line">
148
    <h2 class="property-inline"> Default Value: </h2>
149
    <p class="property-text">1.9.0</p>
150
  </div>
151
  <div class="property-description-line">
152
    <h2 class="property-inline"> Set Method: </h2>
153
    <p class="property-text">Manual</p>
154
  </div>
155
  <div class="property-description-line">
156
    <h2 class="property-inline"> Description: </h2>
157
    <p class="property-text">The Metacat version number.  usually, this should
158
    never be changed.  It is set by the build engineer at build time.</p>
159
  </div>
160
  <div class="property-description-line">
161
    <h2 class="property-inline"> Example: </h2>
162
    <p class="property-text">1.9.0</p>
163 4620 daigle
  </div>
164
165
  <a name="application.metacatReleaseInfo"></a><h1 class="property-main"> application.metacatReleaseInfo </h1>
166
  <div class="property-description-line">
167
    <h2 class="property-inline"> Default Value: </h2>
168
    <p class="property-text">none</p>
169
  </div>
170
  <div class="property-description-line">
171
    <h2 class="property-inline"> Set Method: </h2>
172
    <p class="property-text">Manual</p>
173
  </div>
174
  <div class="property-description-line">
175
    <h2 class="property-inline"> Description: </h2>
176
    <p class="property-text">This allows for some more detailed information about the
177
    release for display purposes.  Typically it is used during the release candidate cycle
178
    to let users know which candidate they are downloading.</p>
179
  </div>
180
  <div class="property-description-line">
181
    <h2 class="property-inline"> Example: </h2>
182
    <p class="property-text">Release Candidate 1</p>
183
  </div>
184 4169 daigle
185
  <a name="application.deployDir"></a><h1 class="property-main"> application.deployDir </h1>
186
  <div class="property-description-line">
187
    <h2 class="property-inline"> Default Value: </h2>
188
    <p class="property-text">(none)</p>
189
  </div>
190
  <div class="property-description-line">
191
    <h2 class="property-inline"> Set Method: </h2>
192
    <p class="property-text">Configuration Utility</p>
193
  </div>
194
  <div class="property-description-line">
195
    <h2 class="property-inline"> Description: </h2>
196
    <p class="property-text">The directory where web applications are deployed.
197
      Many times this is in a directory named "webapps" in the Tomcat installation
198
      directory.  However, Tomcat may be configured to look in a different directory.</p>
199
  </div>
200
  <div class="property-description-line">
201
    <h2 class="property-inline"> Example: </h2>
202
    <p class="property-text">/usr/local/tomcat/webapps</p>
203
  </div>
204
205
  <a name="application.context"></a><h1 class="property-main"> application.context </h1>
206
  <div class="property-description-line">
207
    <h2 class="property-inline"> Default Value: </h2>
208
    <p class="property-text">(none)</p>
209
  </div>
210
  <div class="property-description-line">
211
    <h2 class="property-inline"> Set Method: </h2>
212
    <p class="property-text">Configuration Utility</p>
213
  </div>
214
  <div class="property-description-line">
215
    <h2 class="property-inline"> Description: </h2>
216
    <p class="property-text">Applications run in individual directories in the applicaton
217
      deployment directory.  The name of the application directory is the application
218
      context. This corresponds to the first part of the war file name (the part before .war).
219
      Most commonly, this is "knb", but it can be changed to other things.</p>
220
  </div>
221
  <div class="property-description-line">
222
    <h2 class="property-inline"> Example: </h2>
223
    <p class="property-text">knb</p>
224
  </div>
225
226
  <a name="application.default-style"></a><h1 class="property-main"> application.default-style </h1>
227
  <div class="property-description-line">
228
    <h2 class="property-inline"> Default Value: </h2>
229
    <p class="property-text">default</p>
230
  </div>
231
  <div class="property-description-line">
232
    <h2 class="property-inline"> Set Method: </h2>
233
    <p class="property-text">Configuration Utility</p>
234
  </div>
235
  <div class="property-description-line">
236
    <h2 class="property-inline"> Description: </h2>
237
    <p class="property-text">There are some custom web skins available in Metacat.
238
    Typically these are associated with an organizational theme.  If there is not
239
    a custom skin for your organization, you should leave it as "default".</p>
240
  </div>
241
  <div class="property-description-line">
242
    <h2 class="property-inline"> Example: </h2>
243
    <p class="property-text">default</p>
244
  </div>
245
246
  <a name="application.knbSiteURL"></a><h1 class="property-main"> application.knbSiteURL </h1>
247
  <div class="property-description-line">
248
    <h2 class="property-inline"> Default Value: </h2>
249
    <p class="property-text">http://knb.ecoinformatics.org</p>
250
  </div>
251
  <div class="property-description-line">
252
    <h2 class="property-inline"> Set Method: </h2>
253
    <p class="property-text">Configuration Utility</p>
254
  </div>
255
  <div class="property-description-line">
256
    <h2 class="property-inline"> Description: </h2>
257
    <p class="property-text">The KNB site to redirect to.</p>
258
  </div>
259
  <div class="property-description-line">
260
    <h2 class="property-inline"> Example: </h2>
261
    <p class="property-text">http://knb.ecoinformatics.org</p>
262
  </div>
263
264
  <a name="application.datafilepath"></a><h1 class="property-main"> application.datafilepath </h1>
265
  <div class="property-description-line">
266
    <h2 class="property-inline"> Default Value: </h2>
267
    <p class="property-text">/var/metacat/data</p>
268
  </div>
269
  <div class="property-description-line">
270
    <h2 class="property-inline"> Set Method: </h2>
271
    <p class="property-text">Configuration Utility</p>
272
  </div>
273
  <div class="property-description-line">
274
    <h2 class="property-inline"> Description: </h2>
275
    <p class="property-text">This is the directory whera data files will be stored.
276
      This should be some directory outside the Metacat installation directories so
277
      data files will not get lost when Metacat is upgraded.  The data file directory
278
      must be writable by the user that starts Tomcat (and thus Metacat).</p>
279
  </div>
280
  <div class="property-description-line">
281
    <h2 class="property-inline"> Example: </h2>
282
    <p class="property-text">/var/metacat/data</p>
283
  </div>
284
285
  <a name="application.inlinedatafilepath"></a><h1 class="property-main"> application.inlinedatafilepath </h1>
286
  <div class="property-description-line">
287
    <h2 class="property-inline"> Default Value: </h2>
288
    <p class="property-text">/var/metacat/inline-data</p>
289
  </div>
290
  <div class="property-description-line">
291
    <h2 class="property-inline"> Set Method: </h2>
292
    <p class="property-text">Configuration Utility</p>
293
  </div>
294
  <div class="property-description-line">
295
    <h2 class="property-inline"> Description: </h2>
296
    <p class="property-text">This is the directory where inline data files will
297
      be stored.  Inline data files are created from data that is embedded in EML
298
      metadata.  This should be some directory outside the Metacat installation
299
      directories so data files will not get lost when Metacat is upgraded.  For
300
      clarity of data, this should probably not be the same as application.datafilepath.
301
      The data file directory must be writable by the user that starts Tomcat (and thus Metacat).</p>
302
  </div>
303
  <div class="property-description-line">
304
    <h2 class="property-inline"> Example: </h2>
305
    <p class="property-text">/var/metacat/inline-data</p>
306 4334 daigle
  </div>
307
308
  <a name="application.documentfilepath"></a><h1 class="property-main"> application.documentfilepath </h1>
309
  <div class="property-description-line">
310
    <h2 class="property-inline"> Default Value: </h2>
311
    <p class="property-text">/var/metacat/documents</p>
312
  </div>
313
  <div class="property-description-line">
314
    <h2 class="property-inline"> Set Method: </h2>
315
    <p class="property-text">Configuration Utility</p>
316
  </div>
317
  <div class="property-description-line">
318
    <h2 class="property-inline"> Description: </h2>
319
    <p class="property-text">This is the directory where metadata document files will
320
      be stored.  This should be some directory outside the Metacat installation
321
      directories so document files will not get lost when Metacat is upgraded.  For
322
      clarity of organization, this should probably not be the same as application.datafilepath
323
      or application.inlinedatafilepath. The data file directory must be writable by the
324
      user that starts Tomcat (and thus Metacat).</p>
325
  </div>
326
  <div class="property-description-line">
327
    <h2 class="property-inline"> Example: </h2>
328
    <p class="property-text">/var/metacat/documents</p>
329 4367 daigle
  </div>
330
331
  <a name="application.tempDir"></a><h1 class="property-main"> application.tempDir </h1>
332
  <div class="property-description-line">
333
    <h2 class="property-inline"> Default Value: </h2>
334
    <p class="property-text">/var/metacat/temporary</p>
335
  </div>
336
  <div class="property-description-line">
337
    <h2 class="property-inline"> Set Method: </h2>
338
    <p class="property-text">Manual</p>
339
  </div>
340
  <div class="property-description-line">
341
    <h2 class="property-inline"> Description: </h2>
342
    <p class="property-text">This is the directory that Metacat data registry uses
343
      to store temporary files. This should not be the same as application.datafilepath
344
      or application.inlinedatafilepath (or any other persistant file path) since all files
345
      in this may be purged programatically. The temporary file directory must be writable
346
      by the user that starts Apache. </p>
347
  </div>
348
  <div class="property-description-line">
349
    <h2 class="property-inline"> Example: </h2>
350
    <p class="property-text">/var/metacat/temporary</p>
351
  </div>
352 4169 daigle
353
  <a name="application.cgiDir"></a><h1 class="property-main"> application.cgiDir </h1>
354
  <div class="property-description-line">
355
    <h2 class="property-inline"> Default Value: </h2>
356 4243 daigle
    <p class="property-text">/cgi</p>
357 4169 daigle
  </div>
358
  <div class="property-description-line">
359
    <h2 class="property-inline"> Set Method: </h2>
360 4243 daigle
    <p class="property-text">Manual</p>
361 4169 daigle
  </div>
362
  <div class="property-description-line">
363
    <h2 class="property-inline"> Description: </h2>
364
    <p class="property-text">This is the directory that is configured in
365 4243 daigle
      Apache web server to point to Metacat cgi executables.  The directory is given
366
      relative to the Metacat context directory since the Metacat cgi scripts
367
      are installed with the application code.  For example, if Metacat is installed
368
      in /usr/local/tomcat/knb, then an application.cgiDir of /cgi would point to <br>
369
      &nbsp;&nbsp;&nbsp;&nbsp/usr/local/tomcat/knb/cgi-dir</p>
370 4169 daigle
  </div>
371
  <div class="property-description-line">
372
    <h2 class="property-inline"> Example: </h2>
373 4243 daigle
    <p class="property-text">/cgi-bin</p>
374 4572 daigle
  </div>
375 4169 daigle
376 4572 daigle
  <a name="replication.logdir"></a><h1 class="property-main"> replication.logdir </h1>
377
  <div class="property-description-line">
378
    <h2 class="property-inline"> Default Value: </h2>
379
    <p class="property-text">none</p>
380
  </div>
381
  <div class="property-description-line">
382
    <h2 class="property-inline"> Set Method: </h2>
383
    <p class="property-text">Manual</p>
384
  </div>
385
  <div class="property-description-line">
386
    <h2 class="property-inline"> Description: </h2>
387
    <p class="property-text">If you are using replication, you will need to specify where
388
    you would like the replication log to be written.  You must choose a directoy
389
    that is writable by the user that starts Tomcat.</p>
390
  </div>
391
  <div class="property-description-line">
392
    <h2 class="property-inline"> Example: </h2>
393
    <p class="property-text">/usr/locat/tomcat/logs</p>
394
  </div>
395
396 4188 daigle
  <br>
397
398
  <a name="database.connectionURI"></a><h1 class="property-main"> database.connectionURI </h1>
399
  <div class="property-description-line">
400
    <h2 class="property-inline"> Default Value: </h2>
401
    <p class="property-text">jdbc:postgresql://localhost/metacat</p>
402
  </div>
403
  <div class="property-description-line">
404
    <h2 class="property-inline"> Set Method: </h2>
405
    <p class="property-text">Configuration Utility</p>
406
  </div>
407
  <div class="property-description-line">
408
    <h2 class="property-inline"> Description: </h2>
409
    <p class="property-text">The jdbc connection URI for the main
410
    database instance of Metacat.  The uri is formatted like: <br>
411
    &nbsp;&nbsp;&nbsp;&nbsp;jdbc:&lt;database_type&gt;:thin@&lt;your_server_name&gt;:1521:&lt;metacat_database_name&gt;<br>
412
    An empty database must have been created prior to Metacat
413
    configuration.</p>
414
  </div>
415
  <div class="property-description-line">
416
    <h2 class="property-inline"> Example: </h2>
417
    <p class="property-text">jdbc:postgresql://yourserver.yourdomain.edu/metacat</p>
418
  </div>
419
420 4177 daigle
  <a name="database.user"></a><h1 class="property-main"> database.user </h1>
421
  <div class="property-description-line">
422
    <h2 class="property-inline"> Default Value: </h2>
423
    <p class="property-text">(none)</p>
424
  </div>
425
  <div class="property-description-line">
426
    <h2 class="property-inline"> Set Method: </h2>
427
    <p class="property-text">Configuration Utility</p>
428
  </div>
429
  <div class="property-description-line">
430
    <h2 class="property-inline"> Description: </h2>
431 4188 daigle
    <p class="property-text">The user for the main database instance
432
    of Metacat.  The user must have already been created on the database.</p>
433 4177 daigle
  </div>
434
  <div class="property-description-line">
435
    <h2 class="property-inline"> Example: </h2>
436 4188 daigle
    <p class="property-text">metacat-user</p>
437 4177 daigle
  </div>
438 4169 daigle
439 4188 daigle
  <a name="database.password"></a><h1 class="property-main"> database.password </h1>
440
  <div class="property-description-line">
441
    <h2 class="property-inline"> Default Value: </h2>
442
    <p class="property-text">(none)</p>
443
  </div>
444
  <div class="property-description-line">
445
    <h2 class="property-inline"> Set Method: </h2>
446
    <p class="property-text">Configuration Utility</p>
447
  </div>
448
  <div class="property-description-line">
449
    <h2 class="property-inline"> Description: </h2>
450
    <p class="property-text">The password of the user for the main
451
    database instance of Metacat.  The password must have already been created
452
    for the user.</p>
453
  </div>
454
  <div class="property-description-line">
455
    <h2 class="property-inline"> Example: </h2>
456
    <p class="property-text">securepassword4843</p>
457
  </div>
458
459
  <a name="database.type"></a><h1 class="property-main"> database.type </h1>
460
  <div class="property-description-line">
461
    <h2 class="property-inline"> Default Value: </h2>
462
    <p class="property-text">(none)</p>
463
  </div>
464
  <div class="property-description-line">
465
    <h2 class="property-inline"> Set Method: </h2>
466
    <p class="property-text">Configuration Utility</p>
467
  </div>
468
  <div class="property-description-line">
469
    <h2 class="property-inline"> Description: </h2>
470
    <p class="property-text">The type of database you are running.  Currently,
471
    there are two supported types, Oracle and Postgres.</p>
472
  </div>
473
  <div class="property-description-line">
474
    <h2 class="property-inline"> Example: </h2>
475
    <p class="property-text">postgres</p>
476
  </div>
477 4169 daigle
478 4188 daigle
  <a name="database.driver"></a><h1 class="property-main"> database.driver </h1>
479
  <div class="property-description-line">
480
    <h2 class="property-inline"> Default Value: </h2>
481
    <p class="property-text">(none)</p>
482
  </div>
483
  <div class="property-description-line">
484
    <h2 class="property-inline"> Set Method: </h2>
485
    <p class="property-text">Configuration Utility</p>
486
  </div>
487
  <div class="property-description-line">
488
    <h2 class="property-inline"> Description: </h2>
489
    <p class="property-text">The JDBC driver to be used to access the main
490
    database instance of Metacat.  There is one of these associated with each
491
    type of database.</p>
492
  </div>
493
  <div class="property-description-line">
494
    <h2 class="property-inline"> Example: </h2>
495
    <p class="property-text">org.postgresql.Driver</p>
496
  </div>
497 4169 daigle
498 4188 daigle
  <a name="database.adapter"></a><h1 class="property-main"> database.adapter </h1>
499
  <div class="property-description-line">
500
    <h2 class="property-inline"> Default Value: </h2>
501
    <p class="property-text">(none)</p>
502
  </div>
503
  <div class="property-description-line">
504
    <h2 class="property-inline"> Set Method: </h2>
505
    <p class="property-text">Configuration Utility</p>
506
  </div>
507
  <div class="property-description-line">
508
    <h2 class="property-inline"> Description: </h2>
509
    <p class="property-text">The adapter class that allows Metacat to access your
510
    database type.  There is one of these associated with each type of database.</p>
511
  </div>
512
  <div class="property-description-line">
513
    <h2 class="property-inline"> Example: </h2>
514
    <p class="property-text">edu.ucsb.nceas.dbadapter.PostgresqlAdapter</p>
515
  </div>
516 4169 daigle
517 4188 daigle
  <a name="database.scriptsuffix"></a><h1 class="property-main"> database.scriptsuffix.&lt;database_type&gt; </h1>
518
  <div class="property-description-line">
519
    <h2 class="property-inline"> Default Value: </h2>
520
    <p class="property-text">
521
      <br>&nbsp;&nbsp;&nbsp;&nbsp;database.scriptsuffix.postgres=postgres.sql<br>
522
      &nbsp;&nbsp;&nbsp;&nbsp;database.scriptsuffix.oracle=oracle.sql
523
    </p>
524
  </div>
525
  <div class="property-description-line">
526
    <h2 class="property-inline"> Set Method: </h2>
527
    <p class="property-text">Configuration Utility</p>
528
  </div>
529
  <div class="property-description-line">
530
    <h2 class="property-inline"> Description: </h2>
531
    <p class="property-text">There is a database.scriptsuffix entry for every
532
      supported type of database.  These tell the system which database scripts
533
      to run when installing or updating database schema.</p>
534
  </div>
535
  <div class="property-description-line">
536
    <h2 class="property-inline"> Example: </h2>
537
    <p class="property-text">postgres.sql</p>
538
  </div>
539
540
  <a name="database.upgradeVersion"></a><h1 class="property-main"> database.upgradeVersion.&lt;database_version&gt; </h1>
541
  <div class="property-description-line">
542
    <h2 class="property-inline"> Default Value: </h2>
543
    <p class="property-text">
544
      <br>&nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.0.0.0=xmltables,loaddtdschema<br>
545
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.2.0=upgrade-db-to-1.2<br>
546
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.3.0=upgrade-db-to-1.3<br>
547
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.4.0=upgrade-db-to-1.4<br>
548
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.5.0=upgrade-db-to-1.5<br>
549
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.6.0=upgrade-db-to-1.6<br>
550
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.7.0=upgrade-db-to-1.7<br>
551
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.8.0=upgrade-db-to-1.8<br>
552
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.9.0=upgrade-db-to-1.9
553
    </p>
554
  </div>
555
  <div class="property-description-line">
556
    <h2 class="property-inline"> Set Method: </h2>
557
    <p class="property-text">Configuration Utility</p>
558
  </div>
559
  <div class="property-description-line">
560
    <h2 class="property-inline"> Description: </h2>
561
    <p class="property-text">There is a database.scriptsuffix entry for every
562
      metacat database schema version. (Note that a schema version corresponds
563
      to an application version.) These tell the system which database scripts
564
      to run when installing or updating database schema.</p>
565
  </div>
566
  <div class="property-description-line">
567
    <h2 class="property-inline"> Example: </h2>
568
    <p class="property-text">upgrade-db-to-1.2</p>
569
  </div>
570
571
  <a name="database.initialConnections"></a><h1 class="property-main"> database.initialConnections </h1>
572
  <div class="property-description-line">
573
    <h2 class="property-inline"> Default Value: </h2>
574
    <p class="property-text">5</p>
575
  </div>
576
  <div class="property-description-line">
577
    <h2 class="property-inline"> Set Method: </h2>
578
    <p class="property-text">Manual</p>
579
  </div>
580
  <div class="property-description-line">
581
    <h2 class="property-inline"> Description: </h2>
582
    <p class="property-text"> The number of initial connection that
583
      Metacat creates to the database.</p>
584
  </div>
585
  <div class="property-description-line">
586
    <h2 class="property-inline"> Example: </h2>
587
    <p class="property-text">5</p>
588
  </div>
589
590
  <a name="database.incrementConnections"></a><h1 class="property-main"> database.incrementConnections </h1>
591
  <div class="property-description-line">
592
    <h2 class="property-inline"> Default Value: </h2>
593
    <p class="property-text">5</p>
594
  </div>
595
  <div class="property-description-line">
596
    <h2 class="property-inline"> Set Method: </h2>
597
    <p class="property-text">Manual</p>
598
  </div>
599
  <div class="property-description-line">
600
    <h2 class="property-inline"> Description: </h2>
601
    <p class="property-text"> The number of connections that are created
602
      when Metacat needs more connections.</p>
603
  </div>
604
  <div class="property-description-line">
605
    <h2 class="property-inline"> Example: </h2>
606
    <p class="property-text">5</p>
607
  </div>
608
609
  <a name="database.maximumConnections"></a><h1 class="property-main"> database.maximumConnections </h1>
610
  <div class="property-description-line">
611
    <h2 class="property-inline"> Default Value: </h2>
612
    <p class="property-text">25</p>
613
  </div>
614
  <div class="property-description-line">
615
    <h2 class="property-inline"> Set Method: </h2>
616
    <p class="property-text">Manual</p>
617
  </div>
618
  <div class="property-description-line">
619
    <h2 class="property-inline"> Description: </h2>
620
    <p class="property-text"> The maximum number of database connections
621
      Metacat can make.</p>
622
  </div>
623
  <div class="property-description-line">
624
    <h2 class="property-inline"> Example: </h2>
625
    <p class="property-text">25</p>
626
  </div>
627
628
  <a name="database.maximumConnectionAge"></a><h1 class="property-main"> database.maximumConnectionAge </h1>
629
  <div class="property-description-line">
630
    <h2 class="property-inline"> Default Value: </h2>
631
    <p class="property-text">120000</p>
632
  </div>
633
  <div class="property-description-line">
634
    <h2 class="property-inline"> Set Method: </h2>
635
    <p class="property-text">Manual</p>
636
  </div>
637
  <div class="property-description-line">
638
    <h2 class="property-inline"> Description: </h2>
639
    <p class="property-text"> The maximum time in milliseconds that a database
640
      connection can live.</p>
641
  </div>
642
  <div class="property-description-line">
643
    <h2 class="property-inline"> Example: </h2>
644
    <p class="property-text">120000</p>
645
  </div>
646
647
  <a name="database.maximumConnectionTime"></a><h1 class="property-main"> database.maximumConnectionTime </h1>
648
  <div class="property-description-line">
649
    <h2 class="property-inline"> Default Value: </h2>
650
    <p class="property-text">60000</p>
651
  </div>
652
  <div class="property-description-line">
653
    <h2 class="property-inline"> Set Method: </h2>
654
    <p class="property-text">Manual</p>
655
  </div>
656
  <div class="property-description-line">
657
    <h2 class="property-inline"> Description: </h2>
658
    <p class="property-text"> The maximum time in milliseconds that a database
659
      connection can accumulate in actual connection time.</p>
660
  </div>
661
  <div class="property-description-line">
662
    <h2 class="property-inline"> Example: </h2>
663
    <p class="property-text">60000</p>
664
  </div>
665
666
  <a name="database.maximumUsageNumber"></a><h1 class="property-main"> database.maximumUsageNumber </h1>
667
  <div class="property-description-line">
668
    <h2 class="property-inline"> Default Value: </h2>
669
    <p class="property-text">100</p>
670
  </div>
671
  <div class="property-description-line">
672
    <h2 class="property-inline"> Set Method: </h2>
673
    <p class="property-text">Manual</p>
674
  </div>
675
  <div class="property-description-line">
676
    <h2 class="property-inline"> Description: </h2>
677
    <p class="property-text"> The maximum number of times a single connection
678
      can be used.</p>
679
  </div>
680
  <div class="property-description-line">
681
    <h2 class="property-inline"> Example: </h2>
682
    <p class="property-text">100</p>
683
  </div>
684
685
  <a name="database.numberOfIndexingThreads"></a><h1 class="property-main"> database.numberOfIndexingThreads </h1>
686
  <div class="property-description-line">
687
    <h2 class="property-inline"> Default Value: </h2>
688
    <p class="property-text">5</p>
689
  </div>
690
  <div class="property-description-line">
691
    <h2 class="property-inline"> Set Method: </h2>
692
    <p class="property-text">Manual</p>
693
  </div>
694
  <div class="property-description-line">
695
    <h2 class="property-inline"> Description: </h2>
696
    <p class="property-text"> The number of threads available for indexing.</p>
697
  </div>
698
  <div class="property-description-line">
699
    <h2 class="property-inline"> Example: </h2>
700
    <p class="property-text">5</p>
701
  </div>
702
703
  <a name="database.indexingTimerTaskTime"></a><h1 class="property-main"> database.indexingTimerTaskTime </h1>
704
  <div class="property-description-line">
705
    <h2 class="property-inline"> Default Value: </h2>
706
    <p class="property-text">604800000</p>
707
  </div>
708
  <div class="property-description-line">
709
    <h2 class="property-inline"> Set Method: </h2>
710
    <p class="property-text">Manual</p>
711
  </div>
712
  <div class="property-description-line">
713
    <h2 class="property-inline"> Description: </h2>
714
    <p class="property-text"> The time in milliseconds between indexing.</p>
715
  </div>
716
  <div class="property-description-line">
717
    <h2 class="property-inline"> Example: </h2>
718
    <p class="property-text">604800000</p>
719
  </div>
720
721
  <a name="database.indexingInitialDelay"></a><h1 class="property-main"> database.indexingInitialDelay </h1>
722
  <div class="property-description-line">
723
    <h2 class="property-inline"> Default Value: </h2>
724
    <p class="property-text">3600000</p>
725
  </div>
726
  <div class="property-description-line">
727
    <h2 class="property-inline"> Set Method: </h2>
728
    <p class="property-text">Manual</p>
729
  </div>
730
  <div class="property-description-line">
731
    <h2 class="property-inline"> Description: </h2>
732
    <p class="property-text"> The delay in milliseconds before first indexing is executed.</p>
733
  </div>
734
  <div class="property-description-line">
735
    <h2 class="property-inline"> Example: </h2>
736
    <p class="property-text">3600000</p>
737
  </div>
738
739
  <a name="database.maximumIndexDelay"></a><h1 class="property-main"> database.maximumIndexDelay </h1>
740
  <div class="property-description-line">
741
    <h2 class="property-inline"> Default Value: </h2>
742
    <p class="property-text">5000</p>
743
  </div>
744
  <div class="property-description-line">
745
    <h2 class="property-inline"> Set Method: </h2>
746
    <p class="property-text">Manual</p>
747
  </div>
748
  <div class="property-description-line">
749
    <h2 class="property-inline"> Description: </h2>
750
    <p class="property-text"> The time in milliseconds that an indexing thread
751
      will wait when it can't get a doc id before retrying the indexing.</p>
752
  </div>
753
  <div class="property-description-line">
754
    <h2 class="property-inline"> Example: </h2>
755
    <p class="property-text">5000</p>
756
  </div>
757
758
  <a name="database.runDBConnectionRecycleThread"></a><h1 class="property-main"> database.runDBConnectionRecycleThread </h1>
759
  <div class="property-description-line">
760
    <h2 class="property-inline"> Default Value: </h2>
761
    <p class="property-text">off</p>
762
  </div>
763
  <div class="property-description-line">
764
    <h2 class="property-inline"> Set Method: </h2>
765
    <p class="property-text">Manual</p>
766
  </div>
767
  <div class="property-description-line">
768
    <h2 class="property-inline"> Description: </h2>
769
    <p class="property-text"> Determines whether the database connection
770
      pool should run a thread to recycle connections.  Possible values are
771
      "on" and "off"</p>
772
  </div>
773
  <div class="property-description-line">
774
    <h2 class="property-inline"> Example: </h2>
775
    <p class="property-text">off</p>
776
  </div>
777
778
  <a name="database.cycleTimeOfDBConnection"></a><h1 class="property-main"> database.cycleTimeOfDBConnection </h1>
779
  <div class="property-description-line">
780
    <h2 class="property-inline"> Default Value: </h2>
781
    <p class="property-text">30000</p>
782
  </div>
783
  <div class="property-description-line">
784
    <h2 class="property-inline"> Set Method: </h2>
785
    <p class="property-text">Manual</p>
786
  </div>
787
  <div class="property-description-line">
788
    <h2 class="property-inline"> Description: </h2>
789
    <p class="property-text"> The time in milliseconds between connection
790
      recycling runs.</p>
791
  </div>
792
  <div class="property-description-line">
793
    <h2 class="property-inline"> Example: </h2>
794
    <p class="property-text">30000</p>
795
  </div>
796
797
  <a name="database.queryignoredparams"></a><h1 class="property-main"> database.queryignoredparams </h1>
798
  <div class="property-description-line">
799
    <h2 class="property-inline"> Default Value: </h2>
800
    <p class="property-text">enableediting,foo</p>
801
  </div>
802
  <div class="property-description-line">
803
    <h2 class="property-inline"> Set Method: </h2>
804
    <p class="property-text">Manual</p>
805
  </div>
806
  <div class="property-description-line">
807
    <h2 class="property-inline"> Description: </h2>
808
    <p class="property-text"> Parameters to ignore in a structured
809
      xml query.</p>
810
  </div>
811
  <div class="property-description-line">
812
    <h2 class="property-inline"> Example: </h2>
813
    <p class="property-text">enableediting</p>
814
  </div>
815
816
  <a name="database.usexmlindex"></a><h1 class="property-main"> database.usexmlindex </h1>
817
  <div class="property-description-line">
818
    <h2 class="property-inline"> Default Value: </h2>
819
    <p class="property-text">true</p>
820
  </div>
821
  <div class="property-description-line">
822
    <h2 class="property-inline"> Set Method: </h2>
823
    <p class="property-text">Manual</p>
824
  </div>
825
  <div class="property-description-line">
826
    <h2 class="property-inline"> Description: </h2>
827
    <p class="property-text"> Determines whether to use xml
828
      indexes when finding documents.  Possible values are true
829
      and false.</p>
830
  </div>
831
  <div class="property-description-line">
832
    <h2 class="property-inline"> Example: </h2>
833
    <p class="property-text">true</p>
834
  </div>
835
836 4243 daigle
  <a name="database.appResultsetSize"></a><h1 class="property-main"> database.appResultsetSize </h1>
837
  <div class="property-description-line">
838
    <h2 class="property-inline"> Default Value: </h2>
839
    <p class="property-text">7000</p>
840
  </div>
841
  <div class="property-description-line">
842
    <h2 class="property-inline"> Set Method: </h2>
843
    <p class="property-text">Manual</p>
844
  </div>
845
  <div class="property-description-line">
846
    <h2 class="property-inline"> Description: </h2>
847
    <p class="property-text"> Determines the number of results that get sent
848
    back to an application from a query.</p>
849
  </div>
850
  <div class="property-description-line">
851
    <h2 class="property-inline"> Example: </h2>
852
    <p class="property-text">7000</p>
853
  </div>
854 4188 daigle
855 4243 daigle
  <a name="database.webResultsetSize"></a><h1 class="property-main"> database.webResultsetSize </h1>
856
  <div class="property-description-line">
857
    <h2 class="property-inline"> Default Value: </h2>
858
    <p class="property-text">7000</p>
859
  </div>
860
  <div class="property-description-line">
861
    <h2 class="property-inline"> Set Method: </h2>
862
    <p class="property-text">Manual</p>
863
  </div>
864
  <div class="property-description-line">
865
    <h2 class="property-inline"> Description: </h2>
866
    <p class="property-text"> Determines the number of results that get sent
867
    back to a web browser from a query.</p>
868
  </div>
869
  <div class="property-description-line">
870
    <h2 class="property-inline"> Example: </h2>
871
    <p class="property-text">7000</p>
872
  </div>
873 4188 daigle
874 4243 daigle
  <a name="database.xmlReturnfieldCount"></a><h1 class="property-main"> database.xmlReturnfieldCount </h1>
875
  <div class="property-description-line">
876
    <h2 class="property-inline"> Default Value: </h2>
877
    <p class="property-text">0</p>
878
  </div>
879
  <div class="property-description-line">
880
    <h2 class="property-inline"> Set Method: </h2>
881
    <p class="property-text">Manual</p>
882
  </div>
883
  <div class="property-description-line">
884
    <h2 class="property-inline"> Description: </h2>
885
    <p class="property-text"> If the results of a query have been returned
886
    more times than database.xmlReturnfieldCount, then those results will be
887
    inserted into the xml_queryresult table in the database.</p>
888
  </div>
889
  <div class="property-description-line">
890
    <h2 class="property-inline"> Example: </h2>
891
    <p class="property-text">0</p>
892
  </div>
893
894
  <a name="database.queryresultStringLength"></a><h1 class="property-main"> database.queryresultStringLength </h1>
895
  <div class="property-description-line">
896
    <h2 class="property-inline"> Default Value: </h2>
897
    <p class="property-text">500000</p>
898
  </div>
899
  <div class="property-description-line">
900
    <h2 class="property-inline"> Set Method: </h2>
901
    <p class="property-text">Manual</p>
902
  </div>
903
  <div class="property-description-line">
904
    <h2 class="property-inline"> Description: </h2>
905
    <p class="property-text"> This is used to set the max size of
906
    the query result string in the queryresult table. This should be
907
    set to some number less than 4000 if an Oracle database is being
908
    used.</p>
909
  </div>
910
  <div class="property-description-line">
911
    <h2 class="property-inline"> Example: </h2>
912
    <p class="property-text">500000</p>
913
  </div>
914
915
  <a name="database.queryresultCacheSize"></a><h1 class="property-main"> database.queryresultCacheSize </h1>
916
  <div class="property-description-line">
917
    <h2 class="property-inline"> Default Value: </h2>
918
    <p class="property-text">500</p>
919
  </div>
920
  <div class="property-description-line">
921
    <h2 class="property-inline"> Set Method: </h2>
922
    <p class="property-text">Manual</p>
923
  </div>
924
  <div class="property-description-line">
925
    <h2 class="property-inline"> Description: </h2>
926
    <p class="property-text"> The number of query results that will be cached.</p>
927
  </div>
928
  <div class="property-description-line">
929
    <h2 class="property-inline"> Example: </h2>
930
    <p class="property-text">500</p>
931
  </div>
932
933
  <a name="database.queryCacheOn"></a><h1 class="property-main"> database.queryCacheOn </h1>
934
  <div class="property-description-line">
935
    <h2 class="property-inline"> Default Value: </h2>
936
    <p class="property-text">on</p>
937
  </div>
938
  <div class="property-description-line">
939
    <h2 class="property-inline"> Set Method: </h2>
940
    <p class="property-text">Manual</p>
941
  </div>
942
  <div class="property-description-line">
943
    <h2 class="property-inline"> Description: </h2>
944
    <p class="property-text"> Determines whether query caching is turned on.  Acceptible
945
    values are &quot;on&quot; and &quot;off&quot;</p>
946
  </div>
947
  <div class="property-description-line">
948
    <h2 class="property-inline"> Example: </h2>
949
    <p class="property-text">on</p>
950
  </div>
951
952
  <br>
953
954
  <a name="auth.class"></a><h1 class="property-main"> auth.class </h1>
955
  <div class="property-description-line">
956
    <h2 class="property-inline"> Default Value: </h2>
957
    <p class="property-text">edu.ucsb.nceas.metacat.AuthLdap</p>
958
  </div>
959
  <div class="property-description-line">
960
    <h2 class="property-inline"> Set Method: </h2>
961 4579 daigle
    <p class="property-text">Configuration Utility</p>
962 4243 daigle
  </div>
963
  <div class="property-description-line">
964
    <h2 class="property-inline"> Description: </h2>
965
    <p class="property-text"> The class that is used for user authentication.  Currently,
966
    only the AuthLdap class is included in the Metacat distribution, but it is possible
967
    for an admin to implement other authentication strategies by implementing a Java
968 4579 daigle
    class that extends the AuthInterface interface and rebuilding Metacat.  Change this to
969
    be the fully qualified class name of your custom authentication mechanism.</p>
970 4243 daigle
  </div>
971
  <div class="property-description-line">
972
    <h2 class="property-inline"> Example: </h2>
973
    <p class="property-text">edu.ucsb.nceas.metacat.AuthLdap</p>
974
  </div>
975
976
  <a name="auth.timeoutMinutes"></a><h1 class="property-main"> auth.timeoutMinutes </h1>
977
  <div class="property-description-line">
978
    <h2 class="property-inline"> Default Value: </h2>
979
    <p class="property-text">180</p>
980
  </div>
981
  <div class="property-description-line">
982
    <h2 class="property-inline"> Set Method: </h2>
983
    <p class="property-text">Manual</p>
984
  </div>
985
  <div class="property-description-line">
986
    <h2 class="property-inline"> Description: </h2>
987
    <p class="property-text"> The number of minutes that a user will stay logged
988
    in to Metacat without any activity.</p>
989
  </div>
990
  <div class="property-description-line">
991
    <h2 class="property-inline"> Example: </h2>
992
    <p class="property-text">180</p>
993
  </div>
994
995
  <br>
996
997 4579 daigle
  <a name="auth.administrators"></a><h1 class="property-main"> auth.administrators </h1>
998 4243 daigle
  <div class="property-description-line">
999
    <h2 class="property-inline"> Default Value: </h2>
1000
    <p class="property-text">(none)</p>
1001
  </div>
1002
  <div class="property-description-line">
1003
    <h2 class="property-inline"> Set Method: </h2>
1004
    <p class="property-text">Configuration Utility</p>
1005
  </div>
1006
  <div class="property-description-line">
1007
    <h2 class="property-inline"> Description: </h2>
1008
    <p class="property-text"> A colon separated list of The ldap users
1009
    or groups that have administrative privileges to Metacat.  Note that
1010
    during the intial installation of Metacat, the installer will be
1011 4542 daigle
    asked to enter this value.  <font color="red">At least one
1012
    user or group must be entered and all accounts must exist in LDAP,
1013
    or the installer will not be allowed to continue with the
1014
    configuration.</font></p>
1015 4243 daigle
  </div>
1016
  <div class="property-description-line">
1017
    <h2 class="property-inline"> Example: </h2> <br>
1018
    <p class="property-text">uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org</p><br>
1019
    <p class="property-text">cn=yourgroup,o=NCEAS,dc=ecoinformatics,dc=org</p>
1020
  </div>
1021
1022 4579 daigle
  <a name="auth.url"></a><h1 class="property-main"> auth.url </h1>
1023 4243 daigle
  <div class="property-description-line">
1024
    <h2 class="property-inline"> Default Value: </h2>
1025
    <p class="property-text">ldap://ldap.ecoinformatics.org:389/</p>
1026
  </div>
1027
  <div class="property-description-line">
1028
    <h2 class="property-inline"> Set Method: </h2>
1029
    <p class="property-text">Configuration Utility</p>
1030
  </div>
1031
  <div class="property-description-line">
1032
    <h2 class="property-inline"> Description: </h2>
1033 4579 daigle
    <p class="property-text"> The url of the server that Metacat
1034 4243 daigle
    should use for authentication.</p>
1035
  </div>
1036
  <div class="property-description-line">
1037
    <h2 class="property-inline"> Example: </h2>
1038
    <p class="property-text">ldap://ldap.ecoinformatics.org:389/</p>
1039
  </div>
1040
1041 4579 daigle
  <a name="auth.surl"></a><h1 class="property-main"> auth.surl </h1>
1042 4243 daigle
  <div class="property-description-line">
1043
    <h2 class="property-inline"> Default Value: </h2>
1044
    <p class="property-text">ldap://ldap.ecoinformatics.org:389/</p>
1045
  </div>
1046
  <div class="property-description-line">
1047
    <h2 class="property-inline"> Set Method: </h2>
1048
    <p class="property-text">Configuration Utility</p>
1049
  </div>
1050
  <div class="property-description-line">
1051
    <h2 class="property-inline"> Description: </h2>
1052 4579 daigle
    <p class="property-text"> The url of the server that Metacat
1053 4243 daigle
    should use for  secure authentication.</p>
1054
  </div>
1055
  <div class="property-description-line">
1056
    <h2 class="property-inline"> Example: </h2>
1057
    <p class="property-text">ldap://ldap.ecoinformatics.org:389/</p>
1058 4275 daigle
  </div>
1059 4243 daigle
1060 4579 daigle
  <a name="auth.allowedSubmitters"></a><h1 class="property-main"> auth.allowedSubmitters </h1>
1061 4243 daigle
  <div class="property-description-line">
1062
    <h2 class="property-inline"> Default Value: </h2>
1063
    <p class="property-text">(none)</p>
1064
  </div>
1065
  <div class="property-description-line">
1066
    <h2 class="property-inline"> Set Method: </h2>
1067
    <p class="property-text">Configuration Utility</p>
1068
  </div>
1069
  <div class="property-description-line">
1070
    <h2 class="property-inline"> Description: </h2>
1071
    <p class="property-text"> A colon delimited list of users who should
1072
    be allowed to submit documents. If no value is specified, all users will
1073
    be allowed to submit documents.</p>
1074
  </div>
1075
  <div class="property-description-line">
1076
    <h2 class="property-inline"> Example: </h2>
1077
    <p class="property-text">uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org</p>
1078
  </div>
1079
1080 4579 daigle
  <a name="auth.deniedSubmitters"></a><h1 class="property-main"> auth.deniedSubmitters </h1>
1081 4243 daigle
  <div class="property-description-line">
1082
    <h2 class="property-inline"> Default Value: </h2>
1083
    <p class="property-text">(none)</p>
1084
  </div>
1085
  <div class="property-description-line">
1086
    <h2 class="property-inline"> Set Method: </h2>
1087
    <p class="property-text">Configuration Utility</p>
1088
  </div>
1089
  <div class="property-description-line">
1090
    <h2 class="property-inline"> Description: </h2>
1091
    <p class="property-text"> A colon delimited list of users who should not
1092
    be allowed to submit documents. If no value is specified, all users will
1093
    be allowed to submit documents.</p>
1094
  </div>
1095
  <div class="property-description-line">
1096
    <h2 class="property-inline"> Example: </h2>
1097
    <p class="property-text">uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org</p>
1098
  </div>
1099
1100
  <a name="ldap.connectTimeLimit"></a><h1 class="property-main"> ldap.connectTimeLimit </h1>
1101
  <div class="property-description-line">
1102
    <h2 class="property-inline"> Default Value: </h2>
1103
    <p class="property-text">5000</p>
1104
  </div>
1105
  <div class="property-description-line">
1106
    <h2 class="property-inline"> Set Method: </h2>
1107
    <p class="property-text">Manual</p>
1108
  </div>
1109
  <div class="property-description-line">
1110
    <h2 class="property-inline"> Description: </h2>
1111
    <p class="property-text"> The time in milliseconds allowed for ldap
1112
    server connections.</p>
1113
  </div>
1114
  <div class="property-description-line">
1115
    <h2 class="property-inline"> Example: </h2>
1116
    <p class="property-text">5000</p>
1117
  </div>
1118
1119
  <a name="ldap.searchTimeLimit"></a><h1 class="property-main"> ldap.searchTimeLimit </h1>
1120
  <div class="property-description-line">
1121
    <h2 class="property-inline"> Default Value: </h2>
1122
    <p class="property-text">30000</p>
1123
  </div>
1124
  <div class="property-description-line">
1125
    <h2 class="property-inline"> Set Method: </h2>
1126
    <p class="property-text">Manual</p>
1127
  </div>
1128
  <div class="property-description-line">
1129
    <h2 class="property-inline"> Description: </h2>
1130
    <p class="property-text"> The time in milliseconds allowed for ldap server searches.</p>
1131
  </div>
1132
  <div class="property-description-line">
1133
    <h2 class="property-inline"> Example: </h2>
1134
    <p class="property-text">30000</p>
1135
  </div>
1136
1137
  <a name="ldap.searchCountLimit"></a><h1 class="property-main"> ldap.searchCountLimit </h1>
1138
  <div class="property-description-line">
1139
    <h2 class="property-inline"> Default Value: </h2>
1140
    <p class="property-text">30000</p>
1141
  </div>
1142
  <div class="property-description-line">
1143
    <h2 class="property-inline"> Set Method: </h2>
1144
    <p class="property-text">Manual</p>
1145
  </div>
1146
  <div class="property-description-line">
1147
    <h2 class="property-inline"> Description: </h2>
1148
    <p class="property-text"> the count of return entries allowed for ldap server searches.</p>
1149
  </div>
1150
  <div class="property-description-line">
1151
    <h2 class="property-inline"> Example: </h2>
1152
    <p class="property-text">30000</p>
1153
  </div>
1154
1155
  <a name="ldap.referral"></a><h1 class="property-main"> ldap.referral </h1>
1156
  <div class="property-description-line">
1157
    <h2 class="property-inline"> Default Value: </h2>
1158
    <p class="property-text">follow</p>
1159
  </div>
1160
  <div class="property-description-line">
1161
    <h2 class="property-inline"> Set Method: </h2>
1162
    <p class="property-text">Manual</p>
1163
  </div>
1164
  <div class="property-description-line">
1165
    <h2 class="property-inline"> Description: </h2>
1166
    <p class="property-text"> The type of ldap referrals to use. Acceptible values are
1167
    &quot;follow&quot;, &quot;throw&quot; or &quot;none&quot;. Refer to ldap documentation
1168
    for further information.</p>
1169
  </div>
1170
  <div class="property-description-line">
1171
    <h2 class="property-inline"> Example: </h2>
1172
    <p class="property-text">follow</p>
1173
  </div>
1174
1175
  <a name="ldap.onlySecureConnection"></a><h1 class="property-main"> ldap.onlySecureConnection </h1>
1176
  <div class="property-description-line">
1177
    <h2 class="property-inline"> Default Value: </h2>
1178
    <p class="property-text">false</p>
1179
  </div>
1180
  <div class="property-description-line">
1181
    <h2 class="property-inline"> Set Method: </h2>
1182
    <p class="property-text">Manual</p>
1183
  </div>
1184
  <div class="property-description-line">
1185
    <h2 class="property-inline"> Description: </h2>
1186
    <p class="property-text"> Determines whether to only use secure ldap server.
1187
    Acceptible values are &quot;true&quot; and &quot;false&quot;.</p>
1188
  </div>
1189
  <div class="property-description-line">
1190
    <h2 class="property-inline"> Example: </h2>
1191
    <p class="property-text">false</p>
1192
  </div>
1193
1194
  <a name="ldap.onlySecureReferalsConnection"></a><h1 class="property-main"> ldap.onlySecureReferalsConnection </h1>
1195
  <div class="property-description-line">
1196
    <h2 class="property-inline"> Default Value: </h2>
1197
    <p class="property-text">false</p>
1198
  </div>
1199
  <div class="property-description-line">
1200
    <h2 class="property-inline"> Set Method: </h2>
1201
    <p class="property-text">Manual</p>
1202
  </div>
1203
  <div class="property-description-line">
1204
    <h2 class="property-inline"> Description: </h2>
1205
    <p class="property-text"> Determines whether to only use secure referral server.
1206
    Acceptible values are &quot;true&quot; and &quot;false&quot;.</p>
1207
  </div>
1208
  <div class="property-description-line">
1209
    <h2 class="property-inline"> Example: </h2>
1210
    <p class="property-text">false</p>
1211
  </div>
1212
1213
  <br>
1214
1215
  <a name="xml.saxparser"></a><h1 class="property-main"> xml.saxparser </h1>
1216
  <div class="property-description-line">
1217
    <h2 class="property-inline"> Default Value: </h2>
1218
    <p class="property-text">org.apache.xerces.parsers.SAXParser</p>
1219
  </div>
1220
  <div class="property-description-line">
1221
    <h2 class="property-inline"> Set Method: </h2>
1222
    <p class="property-text">Manual</p>
1223
  </div>
1224
  <div class="property-description-line">
1225
    <h2 class="property-inline"> Description: </h2>
1226
    <p class="property-text"> The SAX parser used to parse XML documents.
1227
    See: <a href="./saxparser.html">SAX parser documentation</a>. </p>
1228
  </div>
1229
  <div class="property-description-line">
1230
    <h2 class="property-inline"> Example: </h2>
1231
    <p class="property-text">org.apache.xerces.parsers.SAXParser</p>
1232
  </div>
1233
1234
  <a name="xml.eml2_0_0namespace"></a><h1 class="property-main"> xml.eml2_0_0namespace </h1>
1235
  <div class="property-description-line">
1236
    <h2 class="property-inline"> Default Value: </h2>
1237
    <p class="property-text">eml://ecoinformatics.org/eml-2.0.0</p>
1238
  </div>
1239
  <div class="property-description-line">
1240
    <h2 class="property-inline"> Set Method: </h2>
1241
    <p class="property-text">Manual</p>
1242
  </div>
1243
  <div class="property-description-line">
1244
    <h2 class="property-inline"> Description: </h2>
1245
    <p class="property-text"> The namespace of EML 2.0.0 documents. </p>
1246
  </div>
1247
  <div class="property-description-line">
1248
    <h2 class="property-inline"> Example: </h2>
1249
    <p class="property-text">eml://ecoinformatics.org/eml-2.0.0</p>
1250
  </div>
1251
1252
  <a name="xml.eml2_0_1namespace"></a><h1 class="property-main"> xml.eml2_0_1namespace </h1>
1253
  <div class="property-description-line">
1254
    <h2 class="property-inline"> Default Value: </h2>
1255
    <p class="property-text">eml://ecoinformatics.org/eml-2.0.1</p>
1256
  </div>
1257
  <div class="property-description-line">
1258
    <h2 class="property-inline"> Set Method: </h2>
1259
    <p class="property-text">Manual</p>
1260
  </div>
1261
  <div class="property-description-line">
1262
    <h2 class="property-inline"> Description: </h2>
1263
    <p class="property-text"> The namespace of EML 2.0.1 documents. </p>
1264
  </div>
1265
  <div class="property-description-line">
1266
    <h2 class="property-inline"> Example: </h2>
1267
    <p class="property-text">eml://ecoinformatics.org/eml-2.0.1</p>
1268
  </div>
1269
1270
  <a name="xml.eml2_1_0namespace"></a><h1 class="property-main"> xml.eml2_1_0namespace </h1>
1271
  <div class="property-description-line">
1272
    <h2 class="property-inline"> Default Value: </h2>
1273
    <p class="property-text">eml://ecoinformatics.org/eml-2.1.0</p>
1274
  </div>
1275
  <div class="property-description-line">
1276
    <h2 class="property-inline"> Set Method: </h2>
1277
    <p class="property-text">Manual</p>
1278
  </div>
1279
  <div class="property-description-line">
1280
    <h2 class="property-inline"> Description: </h2>
1281
    <p class="property-text"> The namespace of EML 2.1.0 documents. </p>
1282
  </div>
1283
  <div class="property-description-line">
1284
    <h2 class="property-inline"> Example: </h2>
1285
    <p class="property-text">eml://ecoinformatics.org/eml-2.1.0</p>
1286
  </div>
1287
1288
  <a name="xml.packagedoctype"></a><h1 class="property-main"> xml.packagedoctype </h1>
1289
  <div class="property-description-line">
1290
    <h2 class="property-inline"> Default Value: </h2>
1291
    <p class="property-text">-//ecoinformatics.org//eml-dataset-2.0.0beta6//EN, -//ecoinformatics.org//eml-dataset-2.0.0beta4//EN</p>
1292
  </div>
1293
  <div class="property-description-line">
1294
    <h2 class="property-inline"> Set Method: </h2>
1295
    <p class="property-text">Manual</p>
1296
  </div>
1297
  <div class="property-description-line">
1298
    <h2 class="property-inline"> Description: </h2>
1299
    <p class="property-text"> The doctype of a package file. The system will only
1300
    recognize documents of this type as package files. See:
1301
    <a href="./packages.html">package documentation</a>.</p>
1302
  </div>
1303
  <div class="property-description-line">
1304
    <h2 class="property-inline"> Example: </h2>
1305
    <p class="property-text">-//ecoinformatics.org//eml-dataset-2.0.0beta6//EN, -//ecoinformatics.org//eml-dataset-2.0.0beta4//EN</p>
1306
  </div>
1307
1308
  <a name="xml.accessdoctype"></a><h1 class="property-main"> xml.accessdoctype </h1>
1309
  <div class="property-description-line">
1310
    <h2 class="property-inline"> Default Value: </h2>
1311
    <p class="property-text">-//ecoinformatics.org//eml-access-2.0.0beta6//EN, -//ecoinformatics.org//eml-access-2.0.0beta4//EN</p>
1312
  </div>
1313
  <div class="property-description-line">
1314
    <h2 class="property-inline"> Set Method: </h2>
1315
    <p class="property-text">Manual</p>
1316
  </div>
1317
  <div class="property-description-line">
1318
    <h2 class="property-inline"> Description: </h2>
1319
    <p class="property-text"> The doctype of an access control list (ACL) file. The
1320 4275 daigle
    system will only recognize documents of this type as access files. See:
1321 4243 daigle
    <a href="./acontrol.html">access control documentation</a>.</p>
1322
  </div>
1323
  <div class="property-description-line">
1324
    <h2 class="property-inline"> Example: </h2>
1325
    <p class="property-text">-//ecoinformatics.org//eml-access-2.0.0beta6//EN, -//ecoinformatics.org//eml-access-2.0.0beta4//EN</p>
1326
  </div>
1327
1328
1329
1330
1331
1332
  <!-- table border="1">
1333 878 berkley
    <tr>
1334
      <td><b>Property</b></td>
1335
      <td><b>Description</b></td>
1336
      <td><b>Possible or default value</b></td>
1337
    </tr>
1338
    <tr>
1339 881 berkley
      <td>config-dir</td>
1340
      <td>directory where the style-sets exist</td>
1341
      <td>/opt/tomcat/webapps/metacat/lib</td>
1342 878 berkley
    </tr>
1343
    <tr>
1344 881 berkley
      <td>default-style</td>
1345
      <td>the style-set to use if qformat is set to 'html'</td>
1346
      <td></td>
1347
    </tr>
1348
    <tr>
1349 878 berkley
      <td>xmlcatalogfile</td>
1350
      <td>The default file type catalog file location.<br>
1351
      DEPRECATED</td>
1352
      <td>/opt/tomcat/webapps/xmltodb/catalog.txt</td>
1353
    </tr>
1354
    <tr>
1355 881 berkley
      <td>siteCode</td>
1356
      <td>The code for the current site.</td>
1357 3591 costa
      <td>nceas</td>
1358 878 berkley
    </tr>
1359
    <tr>
1360
      <td>accNumSeparator</td>
1361
      <td>The separator that is used to separate the three parts
1362
          of the accession number: codename, sequence and revision number.
1363 2309 jones
           changing this parameter will likely break the application, so make
1364
           sure you know what you are doing.  It should be synchronized with
1365
           the Client application.</td>
1366 878 berkley
      <td>. (period)</td>
1367
    </tr>
1368
    <tr>
1369
      <td>saxparser</td>
1370
      <td>The SAX parser to be used to <a href="./saxparser.html">parse</a>
1371
      XML documents.</td>
1372
      <td>org.apache.xerces.parsers.SAXParser</td>
1373
    </tr>
1374
    <tr>
1375
      <td>servletpath</td>
1376
      <td>The path on the local machine to the Metacat Servlet.</td>
1377
      <td>/knb/servlet/metacat</td>
1378
    </tr>
1379
    <tr>
1380
      <td>htmlpath</td>
1381
      <td>The path to the HTML server for this Metacat context.  This is where
1382
      the Metacat web interface would be served from.</td>
1383
      <td>/knb</td>
1384
    </tr>
1385
    <tr>
1386
      <td>packagedoctype</td>
1387
      <td>The doctype of a package file.  The system will only recognize documents
1388
      of this type as a <a href="./packages.html">Package</a> files.</td>
1389
      <td>-//NCEAS//eml-dataset-2.0//EN</td>
1390
    </tr>
1391
    <tr>
1392
      <td>accessdoctype</td>
1393
      <td>The doctype of an access control list (ACL) file.  The system will
1394
          only recognize documents of this type as an <a href="./acontrol.html">Access</a>
1395
          files.</td>
1396
      <td>-//NCEAS//eml-access-2.0//EN</td>
1397
    </tr>
1398
    <tr>
1399
      <td>server</td>
1400
      <td>The server on which this Metacat server runs.</td>
1401
      <td>dev.nceas.ucsb.edu:8090</td>
1402
    </tr>
1403
    <tr>
1404
      <td>authclass</td>
1405
      <td>The authorization plugin to use.  In this example, LDAP.</td>
1406
      <td>edu.ucsb.nceas.metacat.AuthLdap</td>
1407
    </tr>
1408
    <tr>
1409
      <td>ldapurl</td>
1410
      <td>The path to your LDAP server (if LDAP authentication is being used.</td>
1411
      <td>ldap://ldap.nceas.ucsb.edu:389/</td>
1412
    </tr>
1413
    <tr>
1414
      <td>ldapsurl</td>
1415
      <td>The path to your LDAP server with SSL support.
1416
          (if LDAP authentication is being used and if your LDAT server is set
1417
          with SSL support.) 2 ports are used to listen: 389 for plain sockets
1418
          and 636 for SSL Sockect. If your LDAP server is not set to support SSL
1419
          this property should be the same as ldapurl, else Metacat will
1420
          retieve an error.</td>
1421
      <td>ldap://ldap.nceas.ucsb.edu:636/</td>
1422
    </tr>
1423
    <tr>
1424
      <td>ldapbase</td>
1425
      <td>LDAP base parameters for the LDAP server.</td>
1426
      <td>o=NCEAS,c=US</td>
1427
    </tr>
1428
    <tr>
1429 881 berkley
      <td>referral</td>
1430
      <td>The type of ldap referrals you want to use.  Eithe 'follow', 'throw' or
1431
      'none'.  See the ldap documentation for further information</td>
1432
      <td>follow</td>
1433
    </tr>
1434
    <tr>
1435 878 berkley
      <td>deltaT</td>
1436
      <td>The default delta T used for <a href="./replication.html">replication</a>.</td>
1437
      <td>60</td>
1438
    </tr>
1439
    <tr>
1440
      <td>replicationpath</td>
1441
      <td>The relative path to the replication servlet.</td>
1442
      <td>/knb/servlet/replication</td>
1443
    </tr>
1444
    <tr>
1445
      <td>replicationlog</td>
1446
      <td>Location of the replication log file.</td>
1447
      <td>/logs/Metacatreplication.log</td>
1448
    </tr>
1449
    <tr>
1450
      <td>dtdPath</td>
1451
      <td>Path to which DTDs are uploaded.</td>
1452
      <td>/opt/tomcat/webapps/knb/dtd/</td>
1453
    </tr>
1454
    <tr>
1455
      <td>dtdURL</td>
1456
      <td>The HTTP accessable URL to the DTD files specified in dtdPath.</td>
1457
      <td>http://server.domain.com/knb/dtd/</td>
1458
    </tr>
1459
    <tr>
1460
      <td>datafilepath</td>
1461
      <td>The path to which you want data files uploaded.</td>
1462
      <td>/opt/tomcat/webapps/knb/data</td>
1463
    </tr>
1464
    <tr>
1465 881 berkley
      <td>certPath</td>
1466
      <td>path to the SSL keys for secure transmissions.</td>
1467
      <td>/opt/tomcat/webapps/metacat/lib</td>
1468 878 berkley
    </tr>
1469 2309 jones
    <tr>
1470
      <td>administrators</td>
1471
      <td>The administrators parameter lists the accounts that are allowed to
1472
          perform administrative actions such as rebuilding indices for
1473
          documents. The list can can contain more than one account separated
1474
          by colons.</td>
1475
      <td>Default:&nbsp;&nbsp;
1476
          <code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code>
1477
      <br><br>Examples:&nbsp;&nbsp;
1478
          <code>uid=localadmin,o=ucnrs.org</code>
1479
      </td>
1480
    </tr>
1481
    <tr><td> </td></tr>
1482 3591 costa
1483
1484
    <tr><td colspan="3"><b>Additional properties that probably do not need to be changed</b></td></tr>
1485
    <tr><td>configured</td><td>Configuration flag</td><td>true</td></tr>
1486 4169 daigle
    <tr><td>configurationPage</td><td>The page to do metacat configuration<td>/configure.jsp</td></tr>
1487 3591 costa
    <tr><td>configurationSuccessPage</td><td>The page to show successful message after configuration</td><td>/configure-restart.jsp</td></tr>
1488
    <tr><td>version</td><td>Release version.</td><td>1.7.1</td></tr>
1489 2309 jones
    <tr><td>maximumConnectionAge</td><td> </td><td>120000</td></tr>
1490
    <tr><td>maximumConnectionTime</td><td> </td><td>60000</td></tr>
1491
    <tr><td>maximumUsageNumber</td><td> </td><td>100</td></tr>
1492 3591 costa
    <tr><td>numberOfIndexingThreads</td><td> </td><td>5</td></tr>
1493
    <tr><td>indexingTimerTaskTime</td><td> </td><td>604800000</td></tr>
1494
    <tr><td>indexingInitialDelay</td><td> </td><td>3600000</td></tr>
1495
    <tr><td>maximumIndexDelay</td><td> </td><td>5000</td></tr>
1496 2309 jones
    <tr><td>runDBConnectionRecycleThread</td><td> </td><td>off</td></tr>
1497
    <tr><td>cycleTimeOfDBConnection</td><td> </td><td>30000</td></tr>
1498 3591 costa
    <tr>
1499
      <td>timedreplication</td>
1500
      <td>Determines whether timed replication to other metacat servers is being used.</td>
1501
      <td>Default:&nbsp;&nbsp;
1502
          <code>false</code>
1503
      <br><br>Other possible values:&nbsp;&nbsp;
1504
          <code>true</code>
1505
      </td>
1506
    </tr>
1507
    <tr>
1508
      <td>firsttimedreplication</td>
1509
      <td>The time for starting first timed replication if timedreplication is true.
1510
          (See comments in build.properties file for additional details.)</td>
1511
      <td>Default:&nbsp;&nbsp;
1512
          <code>10:00 PM</code>
1513
          <code>&nbsp;</code>
1514
      </td>
1515
    </tr>
1516
    <tr>
1517
      <td>timedreplicationinterval</td>
1518
      <td>The interval to next timed replication if timedreplication is true.
1519
          The value is in milliseconds and default value is 48 hours.</td>
1520
      <td>Default:&nbsp;&nbsp;
1521
          <code>172800000</code>
1522
          <code>&nbsp;</code>
1523
      </td>
1524
    </tr>
1525 2309 jones
    <tr><td>forcereplicationwaitingtime</td><td> </td><td></td></tr>
1526
    <tr><td>eml2_0_0namespace</td><td>Namespace of EML 2.0.0 documents.</td><td>eml://ecoinformatics.org/eml-2.0.0</td></tr>
1527 2463 sgarg
    <tr><td>eml2_0_1namespace</td><td>Namespace of EML 2.0.1 documents.</td><td>eml://ecoinformatics.org/eml-2.0.1</td></tr>
1528 2309 jones
    <tr><td>eml2_1_0namespace</td><td>Namespace of EML 2.1.0 documents. Currently unused, reserved.</td><td>eml://ecoinformatics.org/eml-2.1.0</td></tr>
1529
    <tr><td>physicaldoctype</td><td> </td><td>-//ecoinformatics.org//eml-physical-2.0.0beta6//EN, -//ecoinformatics.org//eml-physical-2.0.0beta4//EN</td></tr>
1530
    <tr><td>entitydoctype</td><td> </td><td>-//ecoinformatics.org//eml-entity-2.0.0beta6//EN, -//ecoinformatics.org//eml-entity-2.0.0beta4//EN</td></tr>
1531
    <tr><td>packagedoctypeset</td><td> </td><td> </td></tr>
1532 3591 costa
    <tr>
1533
      <td>httpserver</td>
1534
      <td>httpserver is the plain HTTP address and port number that Metacat uses for purposes
1535
          other than replication. Since this property is usually composed of the <code>config.hosthame</code> and <code>config.port</code>
1536
          properties (described above), the default setting can be used in most cases.</td>
1537
      <td>Default:&nbsp;&nbsp;<code>${config.hostname}:${config.port}</code>
1538
      </td>
1539
    </tr>
1540 2309 jones
    <tr><td>junittesturl</td><td>The url of the test server.</td><td></td></tr>
1541
    <tr><td>replicationerrorlog</td><td> </td><td></td></tr>
1542
    <tr><td>schemaPath</td><td>Path to installed XSD schemas.</td><td></td></tr>
1543
    <tr><td>schemaURL</td><td>URL to installed XSD schemas.</td><td></td></tr>
1544
    <tr><td>inlinedatafilepath</td><td>Path for storing data that was extracted from <code>inline</code> element of EML documents.</td><td></td></tr>
1545
    <tr><td>context</td><td>The name of the servlet context</td><td></td></tr>
1546
    <tr><td>debuglevel</td><td>Verbosity of debugging messages.  Higher numbers means more debugging detail.</td><td></td></tr>
1547
    <tr><td>datafileflag</td><td> </td><td>datafile</td></tr>
1548
    <tr><td>datafilesizelimit</td><td>Limit on file size for uploaded data files.</td><td>1000</td></tr>
1549
    <tr><td>defaultcontenttype</td><td> </td><td></td></tr>
1550
    <tr><td>query.ignored.params</td><td>Parameters that are passed through to XSLT style sheets without modification.</td><td>enableediting,foo</td></tr>
1551
    <tr><td>usexmlindex</td><td>Flag indicating whether to use the traditional xml_index table or not.  This needs to be set on startup, and once set to false can not be changed back to true without significant database modifications.  Setting this option to 'false' also slows down queries significantly, but it does allow arbitrarily deep dcoument paths.  Not recommended to change this setting -- data loss may result.</td><td>true</td></tr>
1552 2463 sgarg
    <tr><td>app_resultsetsize</td><td>Used for the setting the size of resultset that is processed at a time for applications like morpho</td><td>400</td></tr>
1553
    <tr><td>web_resultsetsize</td><td>Used for the setting the size of resultset for search done using browser</td><td>900</td></tr>
1554
    <tr><td>queryresult_string_length</td><td>Used for the setting the size of queryresult_string in queryresult table</td><td>4000</td></tr>
1555 3591 costa
    <tr>
1556
      <td>queryresult_cache_size</td>
1557
      <td>The size of query result cache.</td>
1558
      <td>Default:&nbsp;&nbsp;500</td>
1559
    </tr>
1560
    <tr>
1561
      <td>query_cache_on</td>
1562
      <td>Turn the query result cache on or off</td>
1563
      <td>Default:&nbsp;&nbsp;true</td>
1564
    </tr>
1565 2463 sgarg
    <tr><td>xml_returnfield_count</td><td>Value of xml_returnfield.usage_count should be more than this value for records to be entered into xml_queryresult</td><td>0</td></tr>
1566 3591 costa
    <tr>
1567 4617 walbridge
      <td><a name="moderators">moderators</a></td>
1568 3591 costa
      <td>Moderator accounts, in a colon-separated list. Special users who will review general user's submission.
1569
             Moderators can approve, revise and reject the submission after reviewing. This property is only used in ESA skin.</td>
1570
      <td>Default:&nbsp;&nbsp;<code>cn=knb-prod,o=NCEAS,dc=ecoinformatics,dc=org</code></td>
1571
    </tr>
1572
    <tr>
1573
      <td>allowedSubmitters</td>
1574
      <td>Specifies the list of users who should be allowed to submit documents.
1575
          If no value is specified (the default setting), all users will be allowed to submit documents.
1576
      </td>
1577
      <td>Default:&nbsp;&nbsp;(no value)</td>
1578
    </tr>
1579
    <tr>
1580
      <td>deniedSubmitters</td>
1581
      <td>Specify the list of users who should not be allowed to submit documents.
1582
          If no value is specified (the default setting), all users will be allowed to submit documents.</td>
1583
      <td>Default:&nbsp;&nbsp;(no value)</td>
1584
    </tr>
1585
    <tr>
1586
      <td>indexNamespaces</td>
1587
      <td>A comma-separated list of doctypes which will be indexed</td>
1588 3780 daigle
      <td>Default:&nbsp;&nbsp;eml://ecoinformatics.org/eml-2.0.0,eml://ecoinformatics.org/eml-2.0.1</td>
1589 3591 costa
    </tr>
1590
    <tr>
1591
      <td>indexPaths</td>
1592 4637 daigle
      <td>See <a href="./metacat-install.html#buildProperties">description of build properties</a></td>
1593 3591 costa
      <td>Default:&nbsp;&nbsp;<code>organizationName,originator/individualName/surName,...</code></td>
1594
    </tr>
1595
    <tr>
1596
      <td>ldapconnecttimelimit</td>
1597
      <td>The time in milliseconds allowed for ldap server connections.</td>
1598
      <td>Default:&nbsp;&nbsp;5000</td>
1599
    </tr>
1600
    <tr>
1601
      <td>ldapsearchtimelimit</td>
1602
      <td>The time in milliseconds allowed for ldap server searches.</td>
1603
      <td>Default:&nbsp;&nbsp;30000</td>
1604
    </tr>
1605
    <tr>
1606
      <td>ldapsearchcountlimit</td>
1607
      <td>The count of return entries allowed for ldap server searches.</td>
1608
      <td>Default:&nbsp;&nbsp;30000</td>
1609
    </tr>
1610
    <tr>
1611
      <td>onlySecureLDAPConnection</td>
1612
      <td>When set to true, connects main LDAP server only by SSL</td>
1613
      <td>Default:&nbsp;&nbsp;false</td>
1614
    </tr>
1615
    <tr>
1616
      <td>onlySecureLDAPReferalsConnection</td>
1617
      <td>When set to true, connects referal LDAP server only by SSL</td>
1618
      <td>Default:&nbsp;&nbsp;false</td>
1619
    </tr>
1620
    <tr>
1621
      <td>skinconfigfiles</td>
1622
      <td>List of skins which have configure files</td>
1623
      <td>Default:&nbsp;&nbsp;esa,nceas,knb,obfs,nrs,sanparks</td>
1624
    </tr>
1625
    <tr>
1626
      <td>writeDebugToFile</td>
1627
      <td>Used for writing debug info into a another output file.</td>
1628
      <td>Default:&nbsp;&nbsp;true</td>
1629
    </tr>
1630
    <tr>
1631
      <td>debugOutputFile</td>
1632
      <td>Output file name where debug info will be written.</td>
1633
      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug</td>
1634
    </tr>
1635
    <tr>
1636
      <td>delimiteredOutputFile</td>
1637
      <td>Delimited text output file name where debug info will be written.</td>
1638
      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug.delimitered</td>
1639
    </tr>
1640
    <tr>
1641
      <td><em>Metacat Harvester properties</em>:<br/><br/>
1642
          connectToMetacat, delay, harvesterAdministrator,
1643
          logPeriod, maxHarvests, period, smtpServer, GetDocError, GetDocSuccess, GetHarvestListError,
1644
          GetHarvestListSuccess, HarvesterStartup, HarvesterShutdown, InsertDocError, InsertDocSuccess,
1645
          MetacatHasDoc, UpdateDocError, UpdateDocSuccess, ValidateDocError, ValidateDocSuccess,
1646
          ValidateHarvestListError, ValidateHarvestListSuccess</td>
1647
      <td>See <a href="./harvester.html">Metacat Harvester</a> documentation</td>
1648
      <td></td>
1649
    </tr>
1650
    <tr>
1651
      <td><em>Spatial properties</em>:<br/><br/>
1652
              runSpatialOption,
1653
              regenerateCacheOnRestart,
1654
              spatialDocnameList,
1655
              eml_westBoundingCoordinatePath,
1656
              eml_eastBoundingCoordinatePath,
1657
              eml_southBoundingCoordinatePath,
1658
              eml_northBoundingCoordinatePath,
1659
              fgdc_westBoundingCoordinatePath,
1660
              fgdc_eastBoundingCoordinatePath,
1661
              fgdc_southBoundingCoordinatePath,
1662
              fgdc_northBoundingCoordinatePath,
1663
              metadata_westBoundingCoordinatePath,
1664
              metadata_eastBoundingCoordinatePath,
1665
              metadata_southBoundingCoordinatePath,
1666
              metadata_northBoundingCoordinatePath,
1667
              docTitle,
1668
              metacatUrl,
1669
              baseUrl
1670
      </td>
1671
      <td>See <a href="./spatial_option.html">Metacat Spatial Option</a> documentation</td>
1672
      <td></td>
1673
    </tr>
1674
    <tr>
1675
      <td>sitemapDirectory</td>
1676
      <td>The relative directory path in which sitemap files should be written.</td>
1677 3659 barteau
      <td>Default:&nbsp;&nbsp;{tomcat_dir}/webapps/{context_name}/sitemaps</td>
1678 3591 costa
    </tr>
1679
    <tr>
1680
      <td>sitemapInterval</td>
1681
      <td>The time interval (in milliseconds) between rebuilding the sitemap.</td>
1682
      <td>Default:&nbsp;&nbsp;86400000</td>
1683
    </tr>
1684 4243 daigle
  </table -->
1685 878 berkley
1686
  <br>
1687
  <a href="./datafiles.html">Back</a> | <a href="./metacattour.html">Home</a> |
1688 2131 costa
  <a href="./harvester.html">Next</a>
1689 878 berkley
1690
1691
</BODY>
1692 4617 walbridge
</HTML>