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 3591 costa
<TITLE>Metacat Properties File</TITLE>
17 878 berkley
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css">
18
</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 3591 costa
  <p>Metacat Server has many dynamically settable properties.
30
     All of them are kept in the <em>metacat.properties</em> file.
31
     Most <a href="./metacatinstall.html#buildProperties">can be set from within
32
     the build file</a> when you first install Metacat.
33
     The following is a summary of each property and its function.
34
  </p>
35 878 berkley
  <table border="1">
36
    <tr>
37
      <td><b>Property</b></td>
38
      <td><b>Description</b></td>
39
      <td><b>Possible or default value</b></td>
40
    </tr>
41
    <tr>
42
      <td>user</td>
43
      <td>The username that Metacat uses to access the backend database.</td>
44
      <td>&nbsp;</td>
45
    </tr>
46
    <tr>
47
      <td>password</td>
48
      <td>The password that Metacat uses to access the backend database.</td>
49
      <td>&nbsp;</td>
50
    </tr>
51
    <tr>
52
      <td>defaultDB</td>
53
      <td>The JDBC connection string that Metacat uses to connect to the backend
54
      database.</td>
55
      <td>jdbc:oracle:thin:@server.domain.com:1521:Metacat</td>
56
    </tr>
57
    <tr>
58
      <td>dbDriver</td>
59
      <td>The JDBC driver to be used to access the backend database.</td>
60
      <td>oracle.jdbc.driver.OracleDriver</td>
61
    </tr>
62
    <tr>
63
      <td>dbAdapter</td>
64
      <td>The name of the RDBMS Adapter Class that Metacat uses to get specific
65
          features in the backend database.</td>
66
      <td>edu.ucsb.nceas.dbadapter.OracleAdapter</td>
67
    </tr>
68
    <tr>
69
      <td>initialConnections</td>
70
      <td>The number of initial connection that Metacat creates to the database.</td>
71
      <td>5</td>
72
    </tr>
73
    <tr>
74
      <td>incrementConnections</td>
75
      <td>The number of connections that are created when Metacat needs more
76
      connections.</td>
77
      <td>5</td>
78
    </tr>
79
    <tr>
80
      <td>maximumConnections</td>
81
      <td>The maximum number of database connection Metacat can make.</td>
82 3591 costa
      <td>25</td>
83 878 berkley
    </tr>
84
    <tr>
85 881 berkley
      <td>config-dir</td>
86
      <td>directory where the style-sets exist</td>
87
      <td>/opt/tomcat/webapps/metacat/lib</td>
88 878 berkley
    </tr>
89
    <tr>
90 881 berkley
      <td>default-style</td>
91
      <td>the style-set to use if qformat is set to 'html'</td>
92
      <td></td>
93
    </tr>
94
    <tr>
95 878 berkley
      <td>xmlcatalogfile</td>
96
      <td>The default file type catalog file location.<br>
97
      DEPRECATED</td>
98
      <td>/opt/tomcat/webapps/xmltodb/catalog.txt</td>
99
    </tr>
100
    <tr>
101 881 berkley
      <td>siteCode</td>
102
      <td>The code for the current site.</td>
103 3591 costa
      <td>nceas</td>
104 878 berkley
    </tr>
105
    <tr>
106
      <td>accNumSeparator</td>
107
      <td>The separator that is used to separate the three parts
108
          of the accession number: codename, sequence and revision number.
109 2309 jones
           changing this parameter will likely break the application, so make
110
           sure you know what you are doing.  It should be synchronized with
111
           the Client application.</td>
112 878 berkley
      <td>. (period)</td>
113
    </tr>
114
    <tr>
115
      <td>saxparser</td>
116
      <td>The SAX parser to be used to <a href="./saxparser.html">parse</a>
117
      XML documents.</td>
118
      <td>org.apache.xerces.parsers.SAXParser</td>
119
    </tr>
120
    <tr>
121
      <td>servletpath</td>
122
      <td>The path on the local machine to the Metacat Servlet.</td>
123
      <td>/knb/servlet/metacat</td>
124
    </tr>
125
    <tr>
126
      <td>htmlpath</td>
127
      <td>The path to the HTML server for this Metacat context.  This is where
128
      the Metacat web interface would be served from.</td>
129
      <td>/knb</td>
130
    </tr>
131
    <tr>
132
      <td>packagedoctype</td>
133
      <td>The doctype of a package file.  The system will only recognize documents
134
      of this type as a <a href="./packages.html">Package</a> files.</td>
135
      <td>-//NCEAS//eml-dataset-2.0//EN</td>
136
    </tr>
137
    <tr>
138
      <td>accessdoctype</td>
139
      <td>The doctype of an access control list (ACL) file.  The system will
140
          only recognize documents of this type as an <a href="./acontrol.html">Access</a>
141
          files.</td>
142
      <td>-//NCEAS//eml-access-2.0//EN</td>
143
    </tr>
144
    <tr>
145
      <td>server</td>
146
      <td>The server on which this Metacat server runs.</td>
147
      <td>dev.nceas.ucsb.edu:8090</td>
148
    </tr>
149
    <tr>
150
      <td>authclass</td>
151
      <td>The authorization plugin to use.  In this example, LDAP.</td>
152
      <td>edu.ucsb.nceas.metacat.AuthLdap</td>
153
    </tr>
154
    <tr>
155
      <td>ldapurl</td>
156
      <td>The path to your LDAP server (if LDAP authentication is being used.</td>
157
      <td>ldap://ldap.nceas.ucsb.edu:389/</td>
158
    </tr>
159
    <tr>
160
      <td>ldapsurl</td>
161
      <td>The path to your LDAP server with SSL support.
162
          (if LDAP authentication is being used and if your LDAT server is set
163
          with SSL support.) 2 ports are used to listen: 389 for plain sockets
164
          and 636 for SSL Sockect. If your LDAP server is not set to support SSL
165
          this property should be the same as ldapurl, else Metacat will
166
          retieve an error.</td>
167
      <td>ldap://ldap.nceas.ucsb.edu:636/</td>
168
    </tr>
169
    <tr>
170
      <td>ldapbase</td>
171
      <td>LDAP base parameters for the LDAP server.</td>
172
      <td>o=NCEAS,c=US</td>
173
    </tr>
174
    <tr>
175 881 berkley
      <td>referral</td>
176
      <td>The type of ldap referrals you want to use.  Eithe 'follow', 'throw' or
177
      'none'.  See the ldap documentation for further information</td>
178
      <td>follow</td>
179
    </tr>
180
    <tr>
181 878 berkley
      <td>deltaT</td>
182
      <td>The default delta T used for <a href="./replication.html">replication</a>.</td>
183
      <td>60</td>
184
    </tr>
185
    <tr>
186
      <td>replicationpath</td>
187
      <td>The relative path to the replication servlet.</td>
188
      <td>/knb/servlet/replication</td>
189
    </tr>
190
    <tr>
191
      <td>replicationlog</td>
192
      <td>Location of the replication log file.</td>
193
      <td>/logs/Metacatreplication.log</td>
194
    </tr>
195
    <tr>
196
      <td>dtdPath</td>
197
      <td>Path to which DTDs are uploaded.</td>
198
      <td>/opt/tomcat/webapps/knb/dtd/</td>
199
    </tr>
200
    <tr>
201
      <td>dtdURL</td>
202
      <td>The HTTP accessable URL to the DTD files specified in dtdPath.</td>
203
      <td>http://server.domain.com/knb/dtd/</td>
204
    </tr>
205
    <tr>
206
      <td>datafilepath</td>
207
      <td>The path to which you want data files uploaded.</td>
208
      <td>/opt/tomcat/webapps/knb/data</td>
209
    </tr>
210
    <tr>
211 881 berkley
      <td>certPath</td>
212
      <td>path to the SSL keys for secure transmissions.</td>
213
      <td>/opt/tomcat/webapps/metacat/lib</td>
214 878 berkley
    </tr>
215 2309 jones
    <tr>
216
      <td>administrators</td>
217
      <td>The administrators parameter lists the accounts that are allowed to
218
          perform administrative actions such as rebuilding indices for
219
          documents. The list can can contain more than one account separated
220
          by colons.</td>
221
      <td>Default:&nbsp;&nbsp;
222
          <code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code>
223
      <br><br>Examples:&nbsp;&nbsp;
224
          <code>uid=localadmin,o=ucnrs.org</code>
225
      </td>
226
    </tr>
227
    <tr><td> </td></tr>
228 3591 costa
229
230
    <tr><td colspan="3"><b>Additional properties that probably do not need to be changed</b></td></tr>
231
    <tr><td>configured</td><td>Configuration flag</td><td>true</td></tr>
232
    <tr><td>configurationPage</td><td></td>The page to do metacat configuration<td>/configure.jsp</td></tr>
233
    <tr><td>configurationSuccessPage</td><td>The page to show successful message after configuration</td><td>/configure-restart.jsp</td></tr>
234
    <tr><td>version</td><td>Release version.</td><td>1.7.1</td></tr>
235 2309 jones
    <tr><td>maximumConnectionAge</td><td> </td><td>120000</td></tr>
236
    <tr><td>maximumConnectionTime</td><td> </td><td>60000</td></tr>
237
    <tr><td>maximumUsageNumber</td><td> </td><td>100</td></tr>
238 3591 costa
    <tr><td>numberOfIndexingThreads</td><td> </td><td>5</td></tr>
239
    <tr><td>indexingTimerTaskTime</td><td> </td><td>604800000</td></tr>
240
    <tr><td>indexingInitialDelay</td><td> </td><td>3600000</td></tr>
241
    <tr><td>maximumIndexDelay</td><td> </td><td>5000</td></tr>
242 2309 jones
    <tr><td>runDBConnectionRecycleThread</td><td> </td><td>off</td></tr>
243
    <tr><td>cycleTimeOfDBConnection</td><td> </td><td>30000</td></tr>
244 3591 costa
    <tr>
245
      <td>timedreplication</td>
246
      <td>Determines whether timed replication to other metacat servers is being used.</td>
247
      <td>Default:&nbsp;&nbsp;
248
          <code>false</code>
249
      <br><br>Other possible values:&nbsp;&nbsp;
250
          <code>true</code>
251
      </td>
252
    </tr>
253
    <tr>
254
      <td>firsttimedreplication</td>
255
      <td>The time for starting first timed replication if timedreplication is true.
256
          (See comments in build.properties file for additional details.)</td>
257
      <td>Default:&nbsp;&nbsp;
258
          <code>10:00 PM</code>
259
          <code>&nbsp;</code>
260
      </td>
261
    </tr>
262
    <tr>
263
      <td>timedreplicationinterval</td>
264
      <td>The interval to next timed replication if timedreplication is true.
265
          The value is in milliseconds and default value is 48 hours.</td>
266
      <td>Default:&nbsp;&nbsp;
267
          <code>172800000</code>
268
          <code>&nbsp;</code>
269
      </td>
270
    </tr>
271 2309 jones
    <tr><td>forcereplicationwaitingtime</td><td> </td><td></td></tr>
272
    <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>
273 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>
274 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>
275
    <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>
276
    <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>
277
    <tr><td>packagedoctypeset</td><td> </td><td> </td></tr>
278 3591 costa
    <tr>
279
      <td>httpserver</td>
280
      <td>httpserver is the plain HTTP address and port number that Metacat uses for purposes
281
          other than replication. Since this property is usually composed of the <code>config.hosthame</code> and <code>config.port</code>
282
          properties (described above), the default setting can be used in most cases.</td>
283
      <td>Default:&nbsp;&nbsp;<code>${config.hostname}:${config.port}</code>
284
      </td>
285
    </tr>
286 2309 jones
    <tr><td>junittesturl</td><td>The url of the test server.</td><td></td></tr>
287
    <tr><td>replicationerrorlog</td><td> </td><td></td></tr>
288
    <tr><td>schemaPath</td><td>Path to installed XSD schemas.</td><td></td></tr>
289
    <tr><td>schemaURL</td><td>URL to installed XSD schemas.</td><td></td></tr>
290
    <tr><td>inlinedatafilepath</td><td>Path for storing data that was extracted from <code>inline</code> element of EML documents.</td><td></td></tr>
291
    <tr><td>context</td><td>The name of the servlet context</td><td></td></tr>
292
    <tr><td>debuglevel</td><td>Verbosity of debugging messages.  Higher numbers means more debugging detail.</td><td></td></tr>
293
    <tr><td>datafileflag</td><td> </td><td>datafile</td></tr>
294
    <tr><td>datafilesizelimit</td><td>Limit on file size for uploaded data files.</td><td>1000</td></tr>
295
    <tr><td>defaultcontenttype</td><td> </td><td></td></tr>
296
    <tr><td>query.ignored.params</td><td>Parameters that are passed through to XSLT style sheets without modification.</td><td>enableediting,foo</td></tr>
297
    <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>
298 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>
299
    <tr><td>web_resultsetsize</td><td>Used for the setting the size of resultset for search done using browser</td><td>900</td></tr>
300
    <tr><td>queryresult_string_length</td><td>Used for the setting the size of queryresult_string in queryresult table</td><td>4000</td></tr>
301 3591 costa
    <tr>
302
      <td>queryresult_cache_size</td>
303
      <td>The size of query result cache.</td>
304
      <td>Default:&nbsp;&nbsp;500</td>
305
    </tr>
306
    <tr>
307
      <td>query_cache_on</td>
308
      <td>Turn the query result cache on or off</td>
309
      <td>Default:&nbsp;&nbsp;true</td>
310
    </tr>
311 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>
312 3591 costa
    <tr>
313
      <td>moderators</td>
314
      <td>Moderator accounts, in a colon-separated list. Special users who will review general user's submission.
315
             Moderators can approve, revise and reject the submission after reviewing. This property is only used in ESA skin.</td>
316
      <td>Default:&nbsp;&nbsp;<code>cn=knb-prod,o=NCEAS,dc=ecoinformatics,dc=org</code></td>
317
    </tr>
318
    <tr>
319
      <td>allowedSubmitters</td>
320
      <td>Specifies the list of users who should be allowed to submit documents.
321
          If no value is specified (the default setting), all users will be allowed to submit documents.
322
      </td>
323
      <td>Default:&nbsp;&nbsp;(no value)</td>
324
    </tr>
325
    <tr>
326
      <td>deniedSubmitters</td>
327
      <td>Specify the list of users who should not be allowed to submit documents.
328
          If no value is specified (the default setting), all users will be allowed to submit documents.</td>
329
      <td>Default:&nbsp;&nbsp;(no value)</td>
330
    </tr>
331
    <tr>
332
      <td>indexNamespaces</td>
333
      <td>A comma-separated list of doctypes which will be indexed</td>
334
      <td>Default:&nbsp;&nbsp;@eml2_0_0namespace@,@eml2_0_1namespace@</td>
335
    </tr>
336
    <tr>
337
      <td>indexPaths</td>
338
      <td>See <a href="./metacatinstall.html#buildProperties">description of build properties</a></td>
339
      <td>Default:&nbsp;&nbsp;<code>organizationName,originator/individualName/surName,...</code></td>
340
    </tr>
341
    <tr>
342
      <td>ldapconnecttimelimit</td>
343
      <td>The time in milliseconds allowed for ldap server connections.</td>
344
      <td>Default:&nbsp;&nbsp;5000</td>
345
    </tr>
346
    <tr>
347
      <td>ldapsearchtimelimit</td>
348
      <td>The time in milliseconds allowed for ldap server searches.</td>
349
      <td>Default:&nbsp;&nbsp;30000</td>
350
    </tr>
351
    <tr>
352
      <td>ldapsearchcountlimit</td>
353
      <td>The count of return entries allowed for ldap server searches.</td>
354
      <td>Default:&nbsp;&nbsp;30000</td>
355
    </tr>
356
    <tr>
357
      <td>onlySecureLDAPConnection</td>
358
      <td>When set to true, connects main LDAP server only by SSL</td>
359
      <td>Default:&nbsp;&nbsp;false</td>
360
    </tr>
361
    <tr>
362
      <td>onlySecureLDAPReferalsConnection</td>
363
      <td>When set to true, connects referal LDAP server only by SSL</td>
364
      <td>Default:&nbsp;&nbsp;false</td>
365
    </tr>
366
    <tr>
367
      <td>skinconfigfiles</td>
368
      <td>List of skins which have configure files</td>
369
      <td>Default:&nbsp;&nbsp;esa,nceas,knb,obfs,nrs,sanparks</td>
370
    </tr>
371
    <tr>
372
      <td>writeDebugToFile</td>
373
      <td>Used for writing debug info into a another output file.</td>
374
      <td>Default:&nbsp;&nbsp;true</td>
375
    </tr>
376
    <tr>
377
      <td>debugOutputFile</td>
378
      <td>Output file name where debug info will be written.</td>
379
      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug</td>
380
    </tr>
381
    <tr>
382
      <td>delimiteredOutputFile</td>
383
      <td>Delimited text output file name where debug info will be written.</td>
384
      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug.delimitered</td>
385
    </tr>
386
    <tr>
387
      <td><em>Metacat Harvester properties</em>:<br/><br/>
388
          connectToMetacat, delay, harvesterAdministrator,
389
          logPeriod, maxHarvests, period, smtpServer, GetDocError, GetDocSuccess, GetHarvestListError,
390
          GetHarvestListSuccess, HarvesterStartup, HarvesterShutdown, InsertDocError, InsertDocSuccess,
391
          MetacatHasDoc, UpdateDocError, UpdateDocSuccess, ValidateDocError, ValidateDocSuccess,
392
          ValidateHarvestListError, ValidateHarvestListSuccess</td>
393
      <td>See <a href="./harvester.html">Metacat Harvester</a> documentation</td>
394
      <td></td>
395
    </tr>
396
    <tr>
397
      <td><em>Spatial properties</em>:<br/><br/>
398
              runSpatialOption,
399
              regenerateCacheOnRestart,
400
              spatialDocnameList,
401
              eml_westBoundingCoordinatePath,
402
              eml_eastBoundingCoordinatePath,
403
              eml_southBoundingCoordinatePath,
404
              eml_northBoundingCoordinatePath,
405
              fgdc_westBoundingCoordinatePath,
406
              fgdc_eastBoundingCoordinatePath,
407
              fgdc_southBoundingCoordinatePath,
408
              fgdc_northBoundingCoordinatePath,
409
              metadata_westBoundingCoordinatePath,
410
              metadata_eastBoundingCoordinatePath,
411
              metadata_southBoundingCoordinatePath,
412
              metadata_northBoundingCoordinatePath,
413
              docTitle,
414
              metacatUrl,
415
              baseUrl
416
      </td>
417
      <td>See <a href="./spatial_option.html">Metacat Spatial Option</a> documentation</td>
418
      <td></td>
419
    </tr>
420
    <tr>
421
      <td>sitemapDirectory</td>
422
      <td>The relative directory path in which sitemap files should be written.</td>
423 3659 barteau
      <td>Default:&nbsp;&nbsp;{tomcat_dir}/webapps/{context_name}/sitemaps</td>
424 3591 costa
    </tr>
425
    <tr>
426
      <td>sitemapInterval</td>
427
      <td>The time interval (in milliseconds) between rebuilding the sitemap.</td>
428
      <td>Default:&nbsp;&nbsp;86400000</td>
429
    </tr>
430 878 berkley
  </table>
431
432
  <br>
433
  <a href="./datafiles.html">Back</a> | <a href="./metacattour.html">Home</a> |
434 2131 costa
  <a href="./harvester.html">Next</a>
435 878 berkley
436
437
</BODY>
438 3659 barteau
</HTML>