Metacat Properties File |
Back | Home | Next |
Metacat Server has many dynamically settable properties. All of them are kept in the metacat.properties file. Most can be set from within the build file when you first install Metacat. The following is a summary of each property and its function.
| Property | Description | Possible or default value |
| user | The username that Metacat uses to access the backend database. | |
| password | The password that Metacat uses to access the backend database. | |
| defaultDB | The JDBC connection string that Metacat uses to connect to the backend database. | jdbc:oracle:thin:@server.domain.com:1521:Metacat |
| dbDriver | The JDBC driver to be used to access the backend database. | oracle.jdbc.driver.OracleDriver |
| dbAdapter | The name of the RDBMS Adapter Class that Metacat uses to get specific features in the backend database. | edu.ucsb.nceas.dbadapter.OracleAdapter |
| initialConnections | The number of initial connection that Metacat creates to the database. | 5 |
| incrementConnections | The number of connections that are created when Metacat needs more connections. | 5 |
| maximumConnections | The maximum number of database connection Metacat can make. | 25 |
| config-dir | directory where the style-sets exist | /opt/tomcat/webapps/metacat/lib |
| default-style | the style-set to use if qformat is set to 'html' | |
| xmlcatalogfile | The default file type catalog file location. DEPRECATED |
/opt/tomcat/webapps/xmltodb/catalog.txt |
| siteCode | The code for the current site. | nceas |
| accNumSeparator | The separator that is used to separate the three parts of the accession number: codename, sequence and revision number. changing this parameter will likely break the application, so make sure you know what you are doing. It should be synchronized with the Client application. | . (period) |
| saxparser | The SAX parser to be used to parse XML documents. | org.apache.xerces.parsers.SAXParser |
| servletpath | The path on the local machine to the Metacat Servlet. | /knb/servlet/metacat |
| htmlpath | The path to the HTML server for this Metacat context. This is where the Metacat web interface would be served from. | /knb |
| packagedoctype | The doctype of a package file. The system will only recognize documents of this type as a Package files. | -//NCEAS//eml-dataset-2.0//EN |
| accessdoctype | The doctype of an access control list (ACL) file. The system will only recognize documents of this type as an Access files. | -//NCEAS//eml-access-2.0//EN |
| server | The server on which this Metacat server runs. | dev.nceas.ucsb.edu:8090 |
| authclass | The authorization plugin to use. In this example, LDAP. | edu.ucsb.nceas.metacat.AuthLdap |
| ldapurl | The path to your LDAP server (if LDAP authentication is being used. | ldap://ldap.nceas.ucsb.edu:389/ |
| ldapsurl | The path to your LDAP server with SSL support. (if LDAP authentication is being used and if your LDAT server is set with SSL support.) 2 ports are used to listen: 389 for plain sockets and 636 for SSL Sockect. If your LDAP server is not set to support SSL this property should be the same as ldapurl, else Metacat will retieve an error. | ldap://ldap.nceas.ucsb.edu:636/ |
| ldapbase | LDAP base parameters for the LDAP server. | o=NCEAS,c=US |
| referral | The type of ldap referrals you want to use. Eithe 'follow', 'throw' or 'none'. See the ldap documentation for further information | follow |
| deltaT | The default delta T used for replication. | 60 |
| replicationpath | The relative path to the replication servlet. | /knb/servlet/replication |
| replicationlog | Location of the replication log file. | /logs/Metacatreplication.log |
| dtdPath | Path to which DTDs are uploaded. | /opt/tomcat/webapps/knb/dtd/ |
| dtdURL | The HTTP accessable URL to the DTD files specified in dtdPath. | http://server.domain.com/knb/dtd/ |
| datafilepath | The path to which you want data files uploaded. | /opt/tomcat/webapps/knb/data |
| certPath | path to the SSL keys for secure transmissions. | /opt/tomcat/webapps/metacat/lib |
| administrators | The administrators parameter lists the accounts that are allowed to perform administrative actions such as rebuilding indices for documents. The list can can contain more than one account separated by colons. | Default:
uid=jones,o=NCEAS,dc=ecoinformatics,dc=org
Examples: uid=localadmin,o=ucnrs.org
|
| Additional properties that probably do not need to be changed | ||
| configured | Configuration flag | true |
| configurationPage | The page to do metacat configuration | /configure.jsp |
| configurationSuccessPage | The page to show successful message after configuration | /configure-restart.jsp |
| version | Release version. | 1.7.1 |
| maximumConnectionAge | 120000 | |
| maximumConnectionTime | 60000 | |
| maximumUsageNumber | 100 | |
| numberOfIndexingThreads | 5 | |
| indexingTimerTaskTime | 604800000 | |
| indexingInitialDelay | 3600000 | |
| maximumIndexDelay | 5000 | |
| runDBConnectionRecycleThread | off | |
| cycleTimeOfDBConnection | 30000 | |
| timedreplication | Determines whether timed replication to other metacat servers is being used. | Default:
false
Other possible values: true
|
| firsttimedreplication | The time for starting first timed replication if timedreplication is true. (See comments in build.properties file for additional details.) | Default:
10:00 PM
|
| timedreplicationinterval | The interval to next timed replication if timedreplication is true. The value is in milliseconds and default value is 48 hours. | Default:
172800000
|
| forcereplicationwaitingtime | ||
| eml2_0_0namespace | Namespace of EML 2.0.0 documents. | eml://ecoinformatics.org/eml-2.0.0 |
| eml2_0_1namespace | Namespace of EML 2.0.1 documents. | eml://ecoinformatics.org/eml-2.0.1 |
| eml2_1_0namespace | Namespace of EML 2.1.0 documents. Currently unused, reserved. | eml://ecoinformatics.org/eml-2.1.0 |
| physicaldoctype | -//ecoinformatics.org//eml-physical-2.0.0beta6//EN, -//ecoinformatics.org//eml-physical-2.0.0beta4//EN | |
| entitydoctype | -//ecoinformatics.org//eml-entity-2.0.0beta6//EN, -//ecoinformatics.org//eml-entity-2.0.0beta4//EN | |
| packagedoctypeset | ||
| httpserver | 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 config.hosthame and config.port
properties (described above), the default setting can be used in most cases. |
Default: ${config.hostname}:${config.port}
|
| junittesturl | The url of the test server. | |
| replicationerrorlog | ||
| schemaPath | Path to installed XSD schemas. | |
| schemaURL | URL to installed XSD schemas. | |
| inlinedatafilepath | Path for storing data that was extracted from inline element of EML documents. | |
| context | The name of the servlet context | |
| debuglevel | Verbosity of debugging messages. Higher numbers means more debugging detail. | |
| datafileflag | datafile | |
| datafilesizelimit | Limit on file size for uploaded data files. | 1000 |
| defaultcontenttype | ||
| query.ignored.params | Parameters that are passed through to XSLT style sheets without modification. | enableediting,foo |
| usexmlindex | 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. | true |
| app_resultsetsize | Used for the setting the size of resultset that is processed at a time for applications like morpho | 400 |
| web_resultsetsize | Used for the setting the size of resultset for search done using browser | 900 |
| queryresult_string_length | Used for the setting the size of queryresult_string in queryresult table | 4000 |
| queryresult_cache_size | The size of query result cache. | Default: 500 |
| query_cache_on | Turn the query result cache on or off | Default: true |
| xml_returnfield_count | Value of xml_returnfield.usage_count should be more than this value for records to be entered into xml_queryresult | 0 |
| moderators | 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. | Default: cn=knb-prod,o=NCEAS,dc=ecoinformatics,dc=org |
| allowedSubmitters | 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. | Default: (no value) |
| deniedSubmitters | 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. | Default: (no value) |
| indexNamespaces | A comma-separated list of doctypes which will be indexed | Default: @eml2_0_0namespace@,@eml2_0_1namespace@ |
| indexPaths | See description of build properties | Default: organizationName,originator/individualName/surName,... |
| ldapconnecttimelimit | The time in milliseconds allowed for ldap server connections. | Default: 5000 |
| ldapsearchtimelimit | The time in milliseconds allowed for ldap server searches. | Default: 30000 |
| ldapsearchcountlimit | The count of return entries allowed for ldap server searches. | Default: 30000 |
| onlySecureLDAPConnection | When set to true, connects main LDAP server only by SSL | Default: false |
| onlySecureLDAPReferalsConnection | When set to true, connects referal LDAP server only by SSL | Default: false |
| skinconfigfiles | List of skins which have configure files | Default: esa,nceas,knb,obfs,nrs,sanparks |
| writeDebugToFile | Used for writing debug info into a another output file. | Default: true |
| debugOutputFile | Output file name where debug info will be written. | Default: /tmp/metacat.debug |
| delimiteredOutputFile | Delimited text output file name where debug info will be written. | Default: /tmp/metacat.debug.delimitered |
| Metacat Harvester properties: connectToMetacat, delay, harvesterAdministrator, logPeriod, maxHarvests, period, smtpServer, GetDocError, GetDocSuccess, GetHarvestListError, GetHarvestListSuccess, HarvesterStartup, HarvesterShutdown, InsertDocError, InsertDocSuccess, MetacatHasDoc, UpdateDocError, UpdateDocSuccess, ValidateDocError, ValidateDocSuccess, ValidateHarvestListError, ValidateHarvestListSuccess |
See Metacat Harvester documentation | |
| Spatial properties: 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 |
See Metacat Spatial Option documentation | |
| sitemapDirectory | The relative directory path in which sitemap files should be written. | Default: @install-dir@/sitemaps |
| sitemapInterval | The time interval (in milliseconds) between rebuilding the sitemap. | Default: 86400000 |