Project

General

Profile

1
<!--
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
<TITLE>Metacat</TITLE>
17
<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
        <a href="./harvester.html">Next</a>
26
      </td>
27
    </tr>
28
  </table>
29
  <p>Metacat Server has many dynamically settable properties.  All of them 
30
  are kept in the Metacat.properties file.  Most can be set from within
31
  the build file when you first install Metacat.  The following is a summary
32
  of each property and its function.</p>
33
  <table border="1">
34
    <tr>
35
      <td><b>Property</b></td>
36
      <td><b>Description</b></td>
37
      <td><b>Possible or default value</b></td>
38
    </tr>
39
    <tr>
40
      <td>user</td>
41
      <td>The username that Metacat uses to access the backend database.</td>
42
      <td>&nbsp;</td>
43
    </tr>
44
    <tr>
45
      <td>password</td>
46
      <td>The password that Metacat uses to access the backend database.</td>
47
      <td>&nbsp;</td>
48
    </tr>
49
    <tr>
50
      <td>defaultDB</td>
51
      <td>The JDBC connection string that Metacat uses to connect to the backend
52
      database.</td>
53
      <td>jdbc:oracle:thin:@server.domain.com:1521:Metacat</td>
54
    </tr>
55
    <tr>
56
      <td>dbDriver</td>
57
      <td>The JDBC driver to be used to access the backend database.</td>
58
      <td>oracle.jdbc.driver.OracleDriver</td>
59
    </tr>
60
    <tr>
61
      <td>dbAdapter</td>
62
      <td>The name of the RDBMS Adapter Class that Metacat uses to get specific
63
          features in the backend database.</td>
64
      <td>edu.ucsb.nceas.dbadapter.OracleAdapter</td>
65
    </tr>
66
    <tr>
67
      <td>initialConnections</td>
68
      <td>The number of initial connection that Metacat creates to the database.</td>
69
      <td>5</td>
70
    </tr>
71
    <tr>
72
      <td>incrementConnections</td>
73
      <td>The number of connections that are created when Metacat needs more 
74
      connections.</td>
75
      <td>5</td>
76
    </tr>
77
    <tr>
78
      <td>maximumConnections</td>
79
      <td>The maximum number of database connection Metacat can make.</td>
80
      <td>10</td>
81
    </tr>
82
    <tr>
83
      <td>config-dir</td>
84
      <td>directory where the style-sets exist</td>
85
      <td>/opt/tomcat/webapps/metacat/lib</td>
86
    </tr>
87
    <tr>
88
      <td>default-style</td>
89
      <td>the style-set to use if qformat is set to 'html'</td>
90
      <td></td>
91
    </tr>
92
    <tr>
93
      <td>xmlcatalogfile</td>
94
      <td>The default file type catalog file location.<br>
95
      DEPRECATED</td>
96
      <td>/opt/tomcat/webapps/xmltodb/catalog.txt</td>
97
    </tr>
98
    <tr>
99
      <td>siteCode</td>
100
      <td>The code for the current site.</td>
101
      <td>NCEAS</td>
102
    </tr>
103
    <tr>
104
      <td>accNumSeparator</td>
105
      <td>The separator that is used to separate the three parts 
106
          of the accession number: codename, sequence and revision number.
107
           changing this parameter will likely break the application, so make
108
           sure you know what you are doing.  It should be synchronized with 
109
           the Client application.</td>
110
      <td>. (period)</td>
111
    </tr>
112
    <tr>
113
      <td>saxparser</td>
114
      <td>The SAX parser to be used to <a href="./saxparser.html">parse</a> 
115
      XML documents.</td>
116
      <td>org.apache.xerces.parsers.SAXParser</td>
117
    </tr>
118
    <tr>
119
      <td>servletpath</td>
120
      <td>The path on the local machine to the Metacat Servlet.</td>
121
      <td>/knb/servlet/metacat</td>
122
    </tr>
123
    <tr>
124
      <td>htmlpath</td>
125
      <td>The path to the HTML server for this Metacat context.  This is where
126
      the Metacat web interface would be served from.</td>
127
      <td>/knb</td>
128
    </tr>
129
    <tr>
130
      <td>packagedoctype</td>
131
      <td>The doctype of a package file.  The system will only recognize documents
132
      of this type as a <a href="./packages.html">Package</a> files.</td>
133
      <td>-//NCEAS//eml-dataset-2.0//EN</td>
134
    </tr>
135
    <tr>
136
      <td>accessdoctype</td>
137
      <td>The doctype of an access control list (ACL) file.  The system will 
138
          only recognize documents of this type as an <a href="./acontrol.html">Access</a> 
139
          files.</td>
140
      <td>-//NCEAS//eml-access-2.0//EN</td>
141
    </tr>
142
    <tr>
143
      <td>server</td>
144
      <td>The server on which this Metacat server runs.</td>
145
      <td>dev.nceas.ucsb.edu:8090</td>
146
    </tr>
147
    <tr>
148
      <td>authclass</td>
149
      <td>The authorization plugin to use.  In this example, LDAP.</td>
150
      <td>edu.ucsb.nceas.metacat.AuthLdap</td>
151
    </tr>
152
    <tr>
153
      <td>ldapurl</td>
154
      <td>The path to your LDAP server (if LDAP authentication is being used.</td>
155
      <td>ldap://ldap.nceas.ucsb.edu:389/</td>
156
    </tr>
157
    <tr>
158
      <td>ldapsurl</td>
159
      <td>The path to your LDAP server with SSL support.
160
          (if LDAP authentication is being used and if your LDAT server is set
161
          with SSL support.) 2 ports are used to listen: 389 for plain sockets 
162
          and 636 for SSL Sockect. If your LDAP server is not set to support SSL
163
          this property should be the same as ldapurl, else Metacat will
164
          retieve an error.</td>
165
      <td>ldap://ldap.nceas.ucsb.edu:636/</td>
166
    </tr>
167
    <tr>
168
      <td>ldapbase</td>
169
      <td>LDAP base parameters for the LDAP server.</td>
170
      <td>o=NCEAS,c=US</td>
171
    </tr>
172
    <tr>
173
      <td>referral</td>
174
      <td>The type of ldap referrals you want to use.  Eithe 'follow', 'throw' or 
175
      'none'.  See the ldap documentation for further information</td>
176
      <td>follow</td>
177
    </tr>
178
    <tr>
179
      <td>deltaT</td>
180
      <td>The default delta T used for <a href="./replication.html">replication</a>.</td>
181
      <td>60</td>
182
    </tr>
183
    <tr>
184
      <td>replicationpath</td>
185
      <td>The relative path to the replication servlet.</td>
186
      <td>/knb/servlet/replication</td>
187
    </tr>
188
    <tr>
189
      <td>replicationlog</td>
190
      <td>Location of the replication log file.</td>
191
      <td>/logs/Metacatreplication.log</td>
192
    </tr>
193
    <tr>
194
      <td>dtdPath</td>
195
      <td>Path to which DTDs are uploaded.</td>
196
      <td>/opt/tomcat/webapps/knb/dtd/</td>
197
    </tr>
198
    <tr>
199
      <td>dtdURL</td>
200
      <td>The HTTP accessable URL to the DTD files specified in dtdPath.</td>
201
      <td>http://server.domain.com/knb/dtd/</td>
202
    </tr>
203
    <tr>
204
      <td>datafilepath</td>
205
      <td>The path to which you want data files uploaded.</td>
206
      <td>/opt/tomcat/webapps/knb/data</td>
207
    </tr>
208
    <tr>
209
      <td>certPath</td>
210
      <td>path to the SSL keys for secure transmissions.</td>
211
      <td>/opt/tomcat/webapps/metacat/lib</td>
212
    </tr>
213
    <tr>
214
      <td>administrators</td>
215
      <td>The administrators parameter lists the accounts that are allowed to
216
          perform administrative actions such as rebuilding indices for 
217
          documents. The list can can contain more than one account separated
218
          by colons.</td>
219
      <td>Default:&nbsp;&nbsp;
220
          <code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code>
221
      <br><br>Examples:&nbsp;&nbsp;
222
          <code>uid=localadmin,o=ucnrs.org</code>
223
      </td>
224
    </tr>
225
    <tr><td> </td></tr>
226
    <tr><td colspan="3"><b>Additional parameters probably not needing to be changed</b></td></tr>
227
    <tr><td>configured</td><td>Configuration flag, currently not used.</td><td>false</td></tr>
228
    <tr><td>version</td><td>Release version.</td><td>1.5.0-</td></tr>
229
    <tr><td>maximumConnectionAge</td><td> </td><td>120000</td></tr>
230
    <tr><td>maximumConnectionTime</td><td> </td><td>60000</td></tr>
231
    <tr><td>maximumUsageNumber</td><td> </td><td>100</td></tr>
232
    <tr><td>runDBConnectionRecycleThread</td><td> </td><td>off</td></tr>
233
    <tr><td>cycleTimeOfDBConnection</td><td> </td><td>30000</td></tr>
234
    <tr><td>forcereplicationwaitingtime</td><td> </td><td></td></tr>
235
    <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>
236
    <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>
237
    <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>
238
    <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>
239
    <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>
240
    <tr><td>packagedoctypeset</td><td> </td><td> </td></tr>
241
    <tr><td>httpserver</td><td> </td><td></td></tr>
242
    <tr><td>junittesturl</td><td>The url of the test server.</td><td></td></tr>
243
    <tr><td>replicationerrorlog</td><td> </td><td></td></tr>
244
    <tr><td>schemaPath</td><td>Path to installed XSD schemas.</td><td></td></tr>
245
    <tr><td>schemaURL</td><td>URL to installed XSD schemas.</td><td></td></tr>
246
    <tr><td>inlinedatafilepath</td><td>Path for storing data that was extracted from <code>inline</code> element of EML documents.</td><td></td></tr>
247
    <tr><td>context</td><td>The name of the servlet context</td><td></td></tr>
248
    <tr><td>debuglevel</td><td>Verbosity of debugging messages.  Higher numbers means more debugging detail.</td><td></td></tr>
249
    <tr><td>datafileflag</td><td> </td><td>datafile</td></tr>
250
    <tr><td>datafilesizelimit</td><td>Limit on file size for uploaded data files.</td><td>1000</td></tr>
251
    <tr><td>defaultcontenttype</td><td> </td><td></td></tr>
252
    <tr><td>query.ignored.params</td><td>Parameters that are passed through to XSLT style sheets without modification.</td><td>enableediting,foo</td></tr>
253
    <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>
254
    <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>
255
    <tr><td>web_resultsetsize</td><td>Used for the setting the size of resultset for search done using browser</td><td>900</td></tr>
256
    <tr><td>queryresult_string_length</td><td>Used for the setting the size of queryresult_string in queryresult table</td><td>4000</td></tr>
257
    <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>
258
  </table>
259
  
260
  <br>
261
  <a href="./datafiles.html">Back</a> | <a href="./metacattour.html">Home</a> | 
262
  <a href="./harvester.html">Next</a>
263
  
264

    
265
</BODY>
266
</HTML>
(39-39/50)