Project

General

Profile

1 878 berkley
<!--
2
  * properties.html
3
  *
4
  *      Authors: Chad Berkley
5
  *    Copyright: 2000 Regents of the University of California and the
6
  *               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
  <h1>Global Metacat Properties - (metacat.properties) </h1>
68
  <hr>
69
70
  <a name="server.name"></a><h1 class="property-main"> server.name </h1>
71
  <div class="property-description-line">
72
    <h2 class="property-inline"> Default Value: </h2>
73
    <p class="property-text">localhost</p>
74
  </div>
75
  <div class="property-description-line">
76
    <h2 class="property-inline"> Set Method: </h2>
77
    <p class="property-text">Configuration Utility</p>
78
  </div>
79
  <div class="property-description-line">
80
    <h2 class="property-inline"> Description: </h2>
81
    <p class="property-text">The network host name that will be
82
      used to access Metacat.  Note that this is not necessarily the physical
83
      name of the server running Metacat.  The host name should not include
84
      the protocol prefix (http://).</p>
85
  </div>
86
  <div class="property-description-line">
87
    <h2 class="property-inline"> Example: </h2>
88
    <p class="property-text">knb.ecoinformatics.org</p>
89
  </div>
90
91
  <a name="server.httpPort"></a><h1 class="property-main"> server.httpPort </h1>
92
  <div class="property-description-line">
93
    <h2 class="property-inline"> Default Value: </h2>
94
    <p class="property-text">80</p>
95
  </div>
96
  <div class="property-description-line">
97
    <h2 class="property-inline"> Set Method: </h2>
98
    <p class="property-text">Configuration Utility</p>
99
  </div>
100
  <div class="property-description-line">
101
    <h2 class="property-inline"> Description: </h2>
102
    <p class="property-text">The network port that will be
103
      used to access Metacat for non-secure (standard) connections.
104
      This is usually 80 if Apache web server is running (typical install), and
105
      8080 if Tomcat is running alone, but both Apache and Tomcat could
106
      have been configured to listen on alternate ports. </p>
107
  </div>
108
  <div class="property-description-line">
109
    <h2 class="property-inline"> Example: </h2>
110
    <p class="property-text">80</p>
111
  </div>
112
113
  <a name="server.httpSSLPort"></a><h1 class="property-main"> server.httpSSLPort </h1>
114
  <div class="property-description-line">
115
    <h2 class="property-inline"> Default Value: </h2>
116
    <p class="property-text">443</p>
117
  </div>
118
  <div class="property-description-line">
119
    <h2 class="property-inline"> Set Method: </h2>
120
    <p class="property-text">Configuration Utility</p>
121
  </div>
122
  <div class="property-description-line">
123
    <h2 class="property-inline"> Description: </h2>
124
    <p class="property-text">The network port that will be
125
      used to access Metacat for secure connections.
126
      This is usually 443 if Apache web server is running (typical install), and
127
      8443 if Tomcat is running alone, but both Apache and Tomcat could
128
      have been configured to listen on alternate ports. </p>
129
  </div>
130
  <div class="property-description-line">
131
    <h2 class="property-inline"> Example: </h2>
132
    <p class="property-text">443</p>
133
  </div>
134
135
  <br>
136
137
  <a name="application.metacatVersion"></a><h1 class="property-main"> application.metacatVersion </h1>
138
  <div class="property-description-line">
139
    <h2 class="property-inline"> Default Value: </h2>
140
    <p class="property-text">1.9.0</p>
141
  </div>
142
  <div class="property-description-line">
143
    <h2 class="property-inline"> Set Method: </h2>
144
    <p class="property-text">Manual</p>
145
  </div>
146
  <div class="property-description-line">
147
    <h2 class="property-inline"> Description: </h2>
148
    <p class="property-text">The Metacat version number.  usually, this should
149
    never be changed.  It is set by the build engineer at build time.</p>
150
  </div>
151
  <div class="property-description-line">
152
    <h2 class="property-inline"> Example: </h2>
153
    <p class="property-text">1.9.0</p>
154
  </div>
155
156
  <a name="application.deployDir"></a><h1 class="property-main"> application.deployDir </h1>
157
  <div class="property-description-line">
158
    <h2 class="property-inline"> Default Value: </h2>
159
    <p class="property-text">(none)</p>
160
  </div>
161
  <div class="property-description-line">
162
    <h2 class="property-inline"> Set Method: </h2>
163
    <p class="property-text">Configuration Utility</p>
164
  </div>
165
  <div class="property-description-line">
166
    <h2 class="property-inline"> Description: </h2>
167
    <p class="property-text">The directory where web applications are deployed.
168
      Many times this is in a directory named "webapps" in the Tomcat installation
169
      directory.  However, Tomcat may be configured to look in a different directory.</p>
170
  </div>
171
  <div class="property-description-line">
172
    <h2 class="property-inline"> Example: </h2>
173
    <p class="property-text">/usr/local/tomcat/webapps</p>
174
  </div>
175
176
  <a name="application.context"></a><h1 class="property-main"> application.context </h1>
177
  <div class="property-description-line">
178
    <h2 class="property-inline"> Default Value: </h2>
179
    <p class="property-text">(none)</p>
180
  </div>
181
  <div class="property-description-line">
182
    <h2 class="property-inline"> Set Method: </h2>
183
    <p class="property-text">Configuration Utility</p>
184
  </div>
185
  <div class="property-description-line">
186
    <h2 class="property-inline"> Description: </h2>
187
    <p class="property-text">Applications run in individual directories in the applicaton
188
      deployment directory.  The name of the application directory is the application
189
      context. This corresponds to the first part of the war file name (the part before .war).
190
      Most commonly, this is "knb", but it can be changed to other things.</p>
191
  </div>
192
  <div class="property-description-line">
193
    <h2 class="property-inline"> Example: </h2>
194
    <p class="property-text">knb</p>
195
  </div>
196
197
  <a name="application.default-style"></a><h1 class="property-main"> application.default-style </h1>
198
  <div class="property-description-line">
199
    <h2 class="property-inline"> Default Value: </h2>
200
    <p class="property-text">default</p>
201
  </div>
202
  <div class="property-description-line">
203
    <h2 class="property-inline"> Set Method: </h2>
204
    <p class="property-text">Configuration Utility</p>
205
  </div>
206
  <div class="property-description-line">
207
    <h2 class="property-inline"> Description: </h2>
208
    <p class="property-text">There are some custom web skins available in Metacat.
209
    Typically these are associated with an organizational theme.  If there is not
210
    a custom skin for your organization, you should leave it as "default".</p>
211
  </div>
212
  <div class="property-description-line">
213
    <h2 class="property-inline"> Example: </h2>
214
    <p class="property-text">default</p>
215
  </div>
216
217
  <a name="application.knbSiteURL"></a><h1 class="property-main"> application.knbSiteURL </h1>
218
  <div class="property-description-line">
219
    <h2 class="property-inline"> Default Value: </h2>
220
    <p class="property-text">http://knb.ecoinformatics.org</p>
221
  </div>
222
  <div class="property-description-line">
223
    <h2 class="property-inline"> Set Method: </h2>
224
    <p class="property-text">Configuration Utility</p>
225
  </div>
226
  <div class="property-description-line">
227
    <h2 class="property-inline"> Description: </h2>
228
    <p class="property-text">The KNB site to redirect to.</p>
229
  </div>
230
  <div class="property-description-line">
231
    <h2 class="property-inline"> Example: </h2>
232
    <p class="property-text">http://knb.ecoinformatics.org</p>
233
  </div>
234
235
  <a name="application.datafilepath"></a><h1 class="property-main"> application.datafilepath </h1>
236
  <div class="property-description-line">
237
    <h2 class="property-inline"> Default Value: </h2>
238
    <p class="property-text">/var/metacat/data</p>
239
  </div>
240
  <div class="property-description-line">
241
    <h2 class="property-inline"> Set Method: </h2>
242
    <p class="property-text">Configuration Utility</p>
243
  </div>
244
  <div class="property-description-line">
245
    <h2 class="property-inline"> Description: </h2>
246
    <p class="property-text">This is the directory whera data files will be stored.
247
      This should be some directory outside the Metacat installation directories so
248
      data files will not get lost when Metacat is upgraded.  The data file directory
249
      must be writable by the user that starts Tomcat (and thus Metacat).</p>
250
  </div>
251
  <div class="property-description-line">
252
    <h2 class="property-inline"> Example: </h2>
253
    <p class="property-text">/var/metacat/data</p>
254
  </div>
255
256
  <a name="application.inlinedatafilepath"></a><h1 class="property-main"> application.inlinedatafilepath </h1>
257
  <div class="property-description-line">
258
    <h2 class="property-inline"> Default Value: </h2>
259
    <p class="property-text">/var/metacat/inline-data</p>
260
  </div>
261
  <div class="property-description-line">
262
    <h2 class="property-inline"> Set Method: </h2>
263
    <p class="property-text">Configuration Utility</p>
264
  </div>
265
  <div class="property-description-line">
266
    <h2 class="property-inline"> Description: </h2>
267
    <p class="property-text">This is the directory where inline data files will
268
      be stored.  Inline data files are created from data that is embedded in EML
269
      metadata.  This should be some directory outside the Metacat installation
270
      directories so data files will not get lost when Metacat is upgraded.  For
271
      clarity of data, this should probably not be the same as application.datafilepath.
272
      The data file directory must be writable by the user that starts Tomcat (and thus Metacat).</p>
273
  </div>
274
  <div class="property-description-line">
275
    <h2 class="property-inline"> Example: </h2>
276
    <p class="property-text">/var/metacat/inline-data</p>
277
  </div>
278
279
  <a name="application.cgiDir"></a><h1 class="property-main"> application.cgiDir </h1>
280
  <div class="property-description-line">
281
    <h2 class="property-inline"> Default Value: </h2>
282
    <p class="property-text">TODO MCD add this</p>
283
  </div>
284
  <div class="property-description-line">
285
    <h2 class="property-inline"> Set Method: </h2>
286
    <p class="property-text">Configuration Utility</p>
287
  </div>
288
  <div class="property-description-line">
289
    <h2 class="property-inline"> Description: </h2>
290
    <p class="property-text">This is the directory that is configured in
291
      Apache web server to have CGI executables.</p>
292
  </div>
293
  <div class="property-description-line">
294
    <h2 class="property-inline"> Example: </h2>
295
    <p class="property-text">TODO MCD add this</p>
296
  </div>
297
298
299
300
301
302
303 878 berkley
  <table border="1">
304
    <tr>
305
      <td><b>Property</b></td>
306
      <td><b>Description</b></td>
307
      <td><b>Possible or default value</b></td>
308
    </tr>
309
    <tr>
310
      <td>user</td>
311
      <td>The username that Metacat uses to access the backend database.</td>
312
      <td>&nbsp;</td>
313
    </tr>
314
    <tr>
315
      <td>password</td>
316
      <td>The password that Metacat uses to access the backend database.</td>
317
      <td>&nbsp;</td>
318
    </tr>
319
    <tr>
320
      <td>defaultDB</td>
321
      <td>The JDBC connection string that Metacat uses to connect to the backend
322
      database.</td>
323
      <td>jdbc:oracle:thin:@server.domain.com:1521:Metacat</td>
324
    </tr>
325
    <tr>
326
      <td>dbDriver</td>
327
      <td>The JDBC driver to be used to access the backend database.</td>
328
      <td>oracle.jdbc.driver.OracleDriver</td>
329
    </tr>
330
    <tr>
331
      <td>dbAdapter</td>
332
      <td>The name of the RDBMS Adapter Class that Metacat uses to get specific
333
          features in the backend database.</td>
334
      <td>edu.ucsb.nceas.dbadapter.OracleAdapter</td>
335
    </tr>
336
    <tr>
337
      <td>initialConnections</td>
338
      <td>The number of initial connection that Metacat creates to the database.</td>
339
      <td>5</td>
340
    </tr>
341
    <tr>
342
      <td>incrementConnections</td>
343
      <td>The number of connections that are created when Metacat needs more
344
      connections.</td>
345
      <td>5</td>
346
    </tr>
347
    <tr>
348
      <td>maximumConnections</td>
349
      <td>The maximum number of database connection Metacat can make.</td>
350 3591 costa
      <td>25</td>
351 878 berkley
    </tr>
352
    <tr>
353 881 berkley
      <td>config-dir</td>
354
      <td>directory where the style-sets exist</td>
355
      <td>/opt/tomcat/webapps/metacat/lib</td>
356 878 berkley
    </tr>
357
    <tr>
358 881 berkley
      <td>default-style</td>
359
      <td>the style-set to use if qformat is set to 'html'</td>
360
      <td></td>
361
    </tr>
362
    <tr>
363 878 berkley
      <td>xmlcatalogfile</td>
364
      <td>The default file type catalog file location.<br>
365
      DEPRECATED</td>
366
      <td>/opt/tomcat/webapps/xmltodb/catalog.txt</td>
367
    </tr>
368
    <tr>
369 881 berkley
      <td>siteCode</td>
370
      <td>The code for the current site.</td>
371 3591 costa
      <td>nceas</td>
372 878 berkley
    </tr>
373
    <tr>
374
      <td>accNumSeparator</td>
375
      <td>The separator that is used to separate the three parts
376
          of the accession number: codename, sequence and revision number.
377 2309 jones
           changing this parameter will likely break the application, so make
378
           sure you know what you are doing.  It should be synchronized with
379
           the Client application.</td>
380 878 berkley
      <td>. (period)</td>
381
    </tr>
382
    <tr>
383
      <td>saxparser</td>
384
      <td>The SAX parser to be used to <a href="./saxparser.html">parse</a>
385
      XML documents.</td>
386
      <td>org.apache.xerces.parsers.SAXParser</td>
387
    </tr>
388
    <tr>
389
      <td>servletpath</td>
390
      <td>The path on the local machine to the Metacat Servlet.</td>
391
      <td>/knb/servlet/metacat</td>
392
    </tr>
393
    <tr>
394
      <td>htmlpath</td>
395
      <td>The path to the HTML server for this Metacat context.  This is where
396
      the Metacat web interface would be served from.</td>
397
      <td>/knb</td>
398
    </tr>
399
    <tr>
400
      <td>packagedoctype</td>
401
      <td>The doctype of a package file.  The system will only recognize documents
402
      of this type as a <a href="./packages.html">Package</a> files.</td>
403
      <td>-//NCEAS//eml-dataset-2.0//EN</td>
404
    </tr>
405
    <tr>
406
      <td>accessdoctype</td>
407
      <td>The doctype of an access control list (ACL) file.  The system will
408
          only recognize documents of this type as an <a href="./acontrol.html">Access</a>
409
          files.</td>
410
      <td>-//NCEAS//eml-access-2.0//EN</td>
411
    </tr>
412
    <tr>
413
      <td>server</td>
414
      <td>The server on which this Metacat server runs.</td>
415
      <td>dev.nceas.ucsb.edu:8090</td>
416
    </tr>
417
    <tr>
418
      <td>authclass</td>
419
      <td>The authorization plugin to use.  In this example, LDAP.</td>
420
      <td>edu.ucsb.nceas.metacat.AuthLdap</td>
421
    </tr>
422
    <tr>
423
      <td>ldapurl</td>
424
      <td>The path to your LDAP server (if LDAP authentication is being used.</td>
425
      <td>ldap://ldap.nceas.ucsb.edu:389/</td>
426
    </tr>
427
    <tr>
428
      <td>ldapsurl</td>
429
      <td>The path to your LDAP server with SSL support.
430
          (if LDAP authentication is being used and if your LDAT server is set
431
          with SSL support.) 2 ports are used to listen: 389 for plain sockets
432
          and 636 for SSL Sockect. If your LDAP server is not set to support SSL
433
          this property should be the same as ldapurl, else Metacat will
434
          retieve an error.</td>
435
      <td>ldap://ldap.nceas.ucsb.edu:636/</td>
436
    </tr>
437
    <tr>
438
      <td>ldapbase</td>
439
      <td>LDAP base parameters for the LDAP server.</td>
440
      <td>o=NCEAS,c=US</td>
441
    </tr>
442
    <tr>
443 881 berkley
      <td>referral</td>
444
      <td>The type of ldap referrals you want to use.  Eithe 'follow', 'throw' or
445
      'none'.  See the ldap documentation for further information</td>
446
      <td>follow</td>
447
    </tr>
448
    <tr>
449 878 berkley
      <td>deltaT</td>
450
      <td>The default delta T used for <a href="./replication.html">replication</a>.</td>
451
      <td>60</td>
452
    </tr>
453
    <tr>
454
      <td>replicationpath</td>
455
      <td>The relative path to the replication servlet.</td>
456
      <td>/knb/servlet/replication</td>
457
    </tr>
458
    <tr>
459
      <td>replicationlog</td>
460
      <td>Location of the replication log file.</td>
461
      <td>/logs/Metacatreplication.log</td>
462
    </tr>
463
    <tr>
464
      <td>dtdPath</td>
465
      <td>Path to which DTDs are uploaded.</td>
466
      <td>/opt/tomcat/webapps/knb/dtd/</td>
467
    </tr>
468
    <tr>
469
      <td>dtdURL</td>
470
      <td>The HTTP accessable URL to the DTD files specified in dtdPath.</td>
471
      <td>http://server.domain.com/knb/dtd/</td>
472
    </tr>
473
    <tr>
474
      <td>datafilepath</td>
475
      <td>The path to which you want data files uploaded.</td>
476
      <td>/opt/tomcat/webapps/knb/data</td>
477
    </tr>
478
    <tr>
479 881 berkley
      <td>certPath</td>
480
      <td>path to the SSL keys for secure transmissions.</td>
481
      <td>/opt/tomcat/webapps/metacat/lib</td>
482 878 berkley
    </tr>
483 2309 jones
    <tr>
484
      <td>administrators</td>
485
      <td>The administrators parameter lists the accounts that are allowed to
486
          perform administrative actions such as rebuilding indices for
487
          documents. The list can can contain more than one account separated
488
          by colons.</td>
489
      <td>Default:&nbsp;&nbsp;
490
          <code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code>
491
      <br><br>Examples:&nbsp;&nbsp;
492
          <code>uid=localadmin,o=ucnrs.org</code>
493
      </td>
494
    </tr>
495
    <tr><td> </td></tr>
496 3591 costa
497
498
    <tr><td colspan="3"><b>Additional properties that probably do not need to be changed</b></td></tr>
499
    <tr><td>configured</td><td>Configuration flag</td><td>true</td></tr>
500 4169 daigle
    <tr><td>configurationPage</td><td>The page to do metacat configuration<td>/configure.jsp</td></tr>
501 3591 costa
    <tr><td>configurationSuccessPage</td><td>The page to show successful message after configuration</td><td>/configure-restart.jsp</td></tr>
502
    <tr><td>version</td><td>Release version.</td><td>1.7.1</td></tr>
503 2309 jones
    <tr><td>maximumConnectionAge</td><td> </td><td>120000</td></tr>
504
    <tr><td>maximumConnectionTime</td><td> </td><td>60000</td></tr>
505
    <tr><td>maximumUsageNumber</td><td> </td><td>100</td></tr>
506 3591 costa
    <tr><td>numberOfIndexingThreads</td><td> </td><td>5</td></tr>
507
    <tr><td>indexingTimerTaskTime</td><td> </td><td>604800000</td></tr>
508
    <tr><td>indexingInitialDelay</td><td> </td><td>3600000</td></tr>
509
    <tr><td>maximumIndexDelay</td><td> </td><td>5000</td></tr>
510 2309 jones
    <tr><td>runDBConnectionRecycleThread</td><td> </td><td>off</td></tr>
511
    <tr><td>cycleTimeOfDBConnection</td><td> </td><td>30000</td></tr>
512 3591 costa
    <tr>
513
      <td>timedreplication</td>
514
      <td>Determines whether timed replication to other metacat servers is being used.</td>
515
      <td>Default:&nbsp;&nbsp;
516
          <code>false</code>
517
      <br><br>Other possible values:&nbsp;&nbsp;
518
          <code>true</code>
519
      </td>
520
    </tr>
521
    <tr>
522
      <td>firsttimedreplication</td>
523
      <td>The time for starting first timed replication if timedreplication is true.
524
          (See comments in build.properties file for additional details.)</td>
525
      <td>Default:&nbsp;&nbsp;
526
          <code>10:00 PM</code>
527
          <code>&nbsp;</code>
528
      </td>
529
    </tr>
530
    <tr>
531
      <td>timedreplicationinterval</td>
532
      <td>The interval to next timed replication if timedreplication is true.
533
          The value is in milliseconds and default value is 48 hours.</td>
534
      <td>Default:&nbsp;&nbsp;
535
          <code>172800000</code>
536
          <code>&nbsp;</code>
537
      </td>
538
    </tr>
539 2309 jones
    <tr><td>forcereplicationwaitingtime</td><td> </td><td></td></tr>
540
    <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>
541 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>
542 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>
543
    <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>
544
    <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>
545
    <tr><td>packagedoctypeset</td><td> </td><td> </td></tr>
546 3591 costa
    <tr>
547
      <td>httpserver</td>
548
      <td>httpserver is the plain HTTP address and port number that Metacat uses for purposes
549
          other than replication. Since this property is usually composed of the <code>config.hosthame</code> and <code>config.port</code>
550
          properties (described above), the default setting can be used in most cases.</td>
551
      <td>Default:&nbsp;&nbsp;<code>${config.hostname}:${config.port}</code>
552
      </td>
553
    </tr>
554 2309 jones
    <tr><td>junittesturl</td><td>The url of the test server.</td><td></td></tr>
555
    <tr><td>replicationerrorlog</td><td> </td><td></td></tr>
556
    <tr><td>schemaPath</td><td>Path to installed XSD schemas.</td><td></td></tr>
557
    <tr><td>schemaURL</td><td>URL to installed XSD schemas.</td><td></td></tr>
558
    <tr><td>inlinedatafilepath</td><td>Path for storing data that was extracted from <code>inline</code> element of EML documents.</td><td></td></tr>
559
    <tr><td>context</td><td>The name of the servlet context</td><td></td></tr>
560
    <tr><td>debuglevel</td><td>Verbosity of debugging messages.  Higher numbers means more debugging detail.</td><td></td></tr>
561
    <tr><td>datafileflag</td><td> </td><td>datafile</td></tr>
562
    <tr><td>datafilesizelimit</td><td>Limit on file size for uploaded data files.</td><td>1000</td></tr>
563
    <tr><td>defaultcontenttype</td><td> </td><td></td></tr>
564
    <tr><td>query.ignored.params</td><td>Parameters that are passed through to XSLT style sheets without modification.</td><td>enableediting,foo</td></tr>
565
    <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>
566 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>
567
    <tr><td>web_resultsetsize</td><td>Used for the setting the size of resultset for search done using browser</td><td>900</td></tr>
568
    <tr><td>queryresult_string_length</td><td>Used for the setting the size of queryresult_string in queryresult table</td><td>4000</td></tr>
569 3591 costa
    <tr>
570
      <td>queryresult_cache_size</td>
571
      <td>The size of query result cache.</td>
572
      <td>Default:&nbsp;&nbsp;500</td>
573
    </tr>
574
    <tr>
575
      <td>query_cache_on</td>
576
      <td>Turn the query result cache on or off</td>
577
      <td>Default:&nbsp;&nbsp;true</td>
578
    </tr>
579 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>
580 3591 costa
    <tr>
581
      <td>moderators</td>
582
      <td>Moderator accounts, in a colon-separated list. Special users who will review general user's submission.
583
             Moderators can approve, revise and reject the submission after reviewing. This property is only used in ESA skin.</td>
584
      <td>Default:&nbsp;&nbsp;<code>cn=knb-prod,o=NCEAS,dc=ecoinformatics,dc=org</code></td>
585
    </tr>
586
    <tr>
587
      <td>allowedSubmitters</td>
588
      <td>Specifies the list of users who should be allowed to submit documents.
589
          If no value is specified (the default setting), all users will be allowed to submit documents.
590
      </td>
591
      <td>Default:&nbsp;&nbsp;(no value)</td>
592
    </tr>
593
    <tr>
594
      <td>deniedSubmitters</td>
595
      <td>Specify the list of users who should not be allowed to submit documents.
596
          If no value is specified (the default setting), all users will be allowed to submit documents.</td>
597
      <td>Default:&nbsp;&nbsp;(no value)</td>
598
    </tr>
599
    <tr>
600
      <td>indexNamespaces</td>
601
      <td>A comma-separated list of doctypes which will be indexed</td>
602 3780 daigle
      <td>Default:&nbsp;&nbsp;eml://ecoinformatics.org/eml-2.0.0,eml://ecoinformatics.org/eml-2.0.1</td>
603 3591 costa
    </tr>
604
    <tr>
605
      <td>indexPaths</td>
606
      <td>See <a href="./metacatinstall.html#buildProperties">description of build properties</a></td>
607
      <td>Default:&nbsp;&nbsp;<code>organizationName,originator/individualName/surName,...</code></td>
608
    </tr>
609
    <tr>
610
      <td>ldapconnecttimelimit</td>
611
      <td>The time in milliseconds allowed for ldap server connections.</td>
612
      <td>Default:&nbsp;&nbsp;5000</td>
613
    </tr>
614
    <tr>
615
      <td>ldapsearchtimelimit</td>
616
      <td>The time in milliseconds allowed for ldap server searches.</td>
617
      <td>Default:&nbsp;&nbsp;30000</td>
618
    </tr>
619
    <tr>
620
      <td>ldapsearchcountlimit</td>
621
      <td>The count of return entries allowed for ldap server searches.</td>
622
      <td>Default:&nbsp;&nbsp;30000</td>
623
    </tr>
624
    <tr>
625
      <td>onlySecureLDAPConnection</td>
626
      <td>When set to true, connects main LDAP server only by SSL</td>
627
      <td>Default:&nbsp;&nbsp;false</td>
628
    </tr>
629
    <tr>
630
      <td>onlySecureLDAPReferalsConnection</td>
631
      <td>When set to true, connects referal LDAP server only by SSL</td>
632
      <td>Default:&nbsp;&nbsp;false</td>
633
    </tr>
634
    <tr>
635
      <td>skinconfigfiles</td>
636
      <td>List of skins which have configure files</td>
637
      <td>Default:&nbsp;&nbsp;esa,nceas,knb,obfs,nrs,sanparks</td>
638
    </tr>
639
    <tr>
640
      <td>writeDebugToFile</td>
641
      <td>Used for writing debug info into a another output file.</td>
642
      <td>Default:&nbsp;&nbsp;true</td>
643
    </tr>
644
    <tr>
645
      <td>debugOutputFile</td>
646
      <td>Output file name where debug info will be written.</td>
647
      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug</td>
648
    </tr>
649
    <tr>
650
      <td>delimiteredOutputFile</td>
651
      <td>Delimited text output file name where debug info will be written.</td>
652
      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug.delimitered</td>
653
    </tr>
654
    <tr>
655
      <td><em>Metacat Harvester properties</em>:<br/><br/>
656
          connectToMetacat, delay, harvesterAdministrator,
657
          logPeriod, maxHarvests, period, smtpServer, GetDocError, GetDocSuccess, GetHarvestListError,
658
          GetHarvestListSuccess, HarvesterStartup, HarvesterShutdown, InsertDocError, InsertDocSuccess,
659
          MetacatHasDoc, UpdateDocError, UpdateDocSuccess, ValidateDocError, ValidateDocSuccess,
660
          ValidateHarvestListError, ValidateHarvestListSuccess</td>
661
      <td>See <a href="./harvester.html">Metacat Harvester</a> documentation</td>
662
      <td></td>
663
    </tr>
664
    <tr>
665
      <td><em>Spatial properties</em>:<br/><br/>
666
              runSpatialOption,
667
              regenerateCacheOnRestart,
668
              spatialDocnameList,
669
              eml_westBoundingCoordinatePath,
670
              eml_eastBoundingCoordinatePath,
671
              eml_southBoundingCoordinatePath,
672
              eml_northBoundingCoordinatePath,
673
              fgdc_westBoundingCoordinatePath,
674
              fgdc_eastBoundingCoordinatePath,
675
              fgdc_southBoundingCoordinatePath,
676
              fgdc_northBoundingCoordinatePath,
677
              metadata_westBoundingCoordinatePath,
678
              metadata_eastBoundingCoordinatePath,
679
              metadata_southBoundingCoordinatePath,
680
              metadata_northBoundingCoordinatePath,
681
              docTitle,
682
              metacatUrl,
683
              baseUrl
684
      </td>
685
      <td>See <a href="./spatial_option.html">Metacat Spatial Option</a> documentation</td>
686
      <td></td>
687
    </tr>
688
    <tr>
689
      <td>sitemapDirectory</td>
690
      <td>The relative directory path in which sitemap files should be written.</td>
691 3659 barteau
      <td>Default:&nbsp;&nbsp;{tomcat_dir}/webapps/{context_name}/sitemaps</td>
692 3591 costa
    </tr>
693
    <tr>
694
      <td>sitemapInterval</td>
695
      <td>The time interval (in milliseconds) between rebuilding the sitemap.</td>
696
      <td>Default:&nbsp;&nbsp;86400000</td>
697
    </tr>
698 878 berkley
  </table>
699
700
  <br>
701
  <a href="./datafiles.html">Back</a> | <a href="./metacattour.html">Home</a> |
702 2131 costa
  <a href="./harvester.html">Next</a>
703 878 berkley
704
705
</BODY>
706 3659 barteau
</HTML>