Metacat

<TITLE>Metacat Properties File</TITLE>

  <p>Metacat Server has many dynamically settable properties.  

     All of them are kept in the <em>metacat.properties</em> file.  

     Most <a href="./metacatinstall.html#buildProperties">can be set from within

     the build file</a> when you first install Metacat. 

     The following is a summary of each property and its function.

  </p>

      <td>25</td>

      <td>nceas</td>

    <tr><td colspan="3"><b>Additional properties that probably do not need to be changed</b></td></tr>

    <tr><td>configured</td><td>Configuration flag</td><td>true</td></tr>

    <tr><td>configurationPage</td><td></td>The page to do metacat configuration<td>/configure.jsp</td></tr>

    <tr><td>configurationSuccessPage</td><td>The page to show successful message after configuration</td><td>/configure-restart.jsp</td></tr>

    <tr><td>version</td><td>Release version.</td><td>1.7.1</td></tr>

    <tr><td>numberOfIndexingThreads</td><td> </td><td>5</td></tr>

    <tr><td>indexingTimerTaskTime</td><td> </td><td>604800000</td></tr>

    <tr><td>indexingInitialDelay</td><td> </td><td>3600000</td></tr>

    <tr><td>maximumIndexDelay</td><td> </td><td>5000</td></tr>

    <tr>

      <td>timedreplication</td>

      <td>Determines whether timed replication to other metacat servers is being used.</td>

      <td>Default:&nbsp;&nbsp;

          <code>false</code>

      <br><br>Other possible values:&nbsp;&nbsp;

          <code>true</code>

      </td>

    </tr>

    <tr>

      <td>firsttimedreplication</td>

      <td>The time for starting first timed replication if timedreplication is true.

          (See comments in build.properties file for additional details.)</td>

      <td>Default:&nbsp;&nbsp;

          <code>10:00 PM</code>

          <code>&nbsp;</code>

      </td>

    </tr>

    <tr>

      <td>timedreplicationinterval</td>

      <td>The interval to next timed replication if timedreplication is true.

          The value is in milliseconds and default value is 48 hours.</td>

      <td>Default:&nbsp;&nbsp;

          <code>172800000</code>

          <code>&nbsp;</code>

      </td>

    </tr>

    <tr>

      <td>httpserver</td>

      <td>httpserver is the plain HTTP address and port number that Metacat uses for purposes

          other than replication. Since this property is usually composed of the <code>config.hosthame</code> and <code>config.port</code>

          properties (described above), the default setting can be used in most cases.</td>

      <td>Default:&nbsp;&nbsp;<code>${config.hostname}:${config.port}</code>

      </td>

    </tr>

    <tr>

      <td>queryresult_cache_size</td>

      <td>The size of query result cache.</td>

      <td>Default:&nbsp;&nbsp;500</td>

    </tr>

    <tr>

      <td>query_cache_on</td>

      <td>Turn the query result cache on or off</td>

      <td>Default:&nbsp;&nbsp;true</td>

    </tr>

    <tr>

      <td>moderators</td>

      <td>Moderator accounts, in a colon-separated list. Special users who will review general user's submission. 

             Moderators can approve, revise and reject the submission after reviewing. This property is only used in ESA skin.</td>

      <td>Default:&nbsp;&nbsp;<code>cn=knb-prod,o=NCEAS,dc=ecoinformatics,dc=org</code></td>

    </tr>

    <tr>

      <td>allowedSubmitters</td>

      <td>Specifies the list of users who should be allowed to submit documents. 

          If no value is specified (the default setting), all users will be allowed to submit documents.

      </td>

      <td>Default:&nbsp;&nbsp;(no value)</td>

    </tr>

    <tr>

      <td>deniedSubmitters</td>

      <td>Specify the list of users who should not be allowed to submit documents. 

          If no value is specified (the default setting), all users will be allowed to submit documents.</td>

      <td>Default:&nbsp;&nbsp;(no value)</td>

    </tr>

    <tr>

      <td>indexNamespaces</td>

      <td>A comma-separated list of doctypes which will be indexed</td>

      <td>Default:&nbsp;&nbsp;@eml2_0_0namespace@,@eml2_0_1namespace@</td>

    </tr>

    <tr>

      <td>indexPaths</td>

      <td>See <a href="./metacatinstall.html#buildProperties">description of build properties</a></td>

      <td>Default:&nbsp;&nbsp;<code>organizationName,originator/individualName/surName,...</code></td>

    </tr>

    <tr>

      <td>ldapconnecttimelimit</td>

      <td>The time in milliseconds allowed for ldap server connections.</td>

      <td>Default:&nbsp;&nbsp;5000</td>

    </tr>

    <tr>

      <td>ldapsearchtimelimit</td>

      <td>The time in milliseconds allowed for ldap server searches.</td>

      <td>Default:&nbsp;&nbsp;30000</td>

    </tr>

    <tr>

      <td>ldapsearchcountlimit</td>

      <td>The count of return entries allowed for ldap server searches.</td>

      <td>Default:&nbsp;&nbsp;30000</td>

    </tr>

    <tr>

      <td>onlySecureLDAPConnection</td>

      <td>When set to true, connects main LDAP server only by SSL</td>

      <td>Default:&nbsp;&nbsp;false</td>

    </tr>

    <tr>

      <td>onlySecureLDAPReferalsConnection</td>

      <td>When set to true, connects referal LDAP server only by SSL</td>

      <td>Default:&nbsp;&nbsp;false</td>

    </tr>

    <tr>

      <td>skinconfigfiles</td>

      <td>List of skins which have configure files</td>

      <td>Default:&nbsp;&nbsp;esa,nceas,knb,obfs,nrs,sanparks</td>

    </tr>

    <tr>

      <td>writeDebugToFile</td>

      <td>Used for writing debug info into a another output file.</td>

      <td>Default:&nbsp;&nbsp;true</td>

    </tr>

    <tr>

      <td>debugOutputFile</td>

      <td>Output file name where debug info will be written.</td>

      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug</td>

    </tr>

    <tr>

      <td>delimiteredOutputFile</td>

      <td>Delimited text output file name where debug info will be written.</td>

      <td>Default:&nbsp;&nbsp;/tmp/metacat.debug.delimitered</td>

    </tr>

    <tr>

      <td><em>Metacat Harvester properties</em>:<br/><br/>

          connectToMetacat, delay, harvesterAdministrator, 

          logPeriod, maxHarvests, period, smtpServer, GetDocError, GetDocSuccess, GetHarvestListError,

          GetHarvestListSuccess, HarvesterStartup, HarvesterShutdown, InsertDocError, InsertDocSuccess,

          MetacatHasDoc, UpdateDocError, UpdateDocSuccess, ValidateDocError, ValidateDocSuccess,

          ValidateHarvestListError, ValidateHarvestListSuccess</td>

      <td>See <a href="./harvester.html">Metacat Harvester</a> documentation</td>

      <td></td>

    </tr>

    <tr>

      <td><em>Spatial properties</em>:<br/><br/>

              runSpatialOption,

              regenerateCacheOnRestart,

              spatialDocnameList,

              eml_westBoundingCoordinatePath,

              eml_eastBoundingCoordinatePath,

              eml_southBoundingCoordinatePath,

              eml_northBoundingCoordinatePath,

              fgdc_westBoundingCoordinatePath,

              fgdc_eastBoundingCoordinatePath,

              fgdc_southBoundingCoordinatePath,

              fgdc_northBoundingCoordinatePath,

              metadata_westBoundingCoordinatePath,

              metadata_eastBoundingCoordinatePath,

              metadata_southBoundingCoordinatePath,

              metadata_northBoundingCoordinatePath,

              docTitle,

              metacatUrl,

              baseUrl

      </td>

      <td>See <a href="./spatial_option.html">Metacat Spatial Option</a> documentation</td>

      <td></td>

    </tr>

    <tr>

      <td>sitemapDirectory</td>

      <td>The relative directory path in which sitemap files should be written.</td>

      <td>Default:&nbsp;&nbsp;@install-dir@/sitemaps</td>

    </tr>

    <tr>

      <td>sitemapInterval</td>

      <td>The time interval (in milliseconds) between rebuilding the sitemap.</td>

      <td>Default:&nbsp;&nbsp;86400000</td>

    </tr>