Project

General

Profile

« Previous | Next » 

Revision 2157

Added by Duane Costa over 20 years ago

Revise documentation after relocating Harvester properties to metacat.properties.

View differences:

docs/user/harvester.html
134 134 
     Additionally, Harvester has a number of settable properties that
135 135 
     control its behavior. All Harvester configuration information is managed
136 136 
     in a single file,
137 
     <a href=../../lib/harvester/harvester.properties>harvester.properties</a>,
137 
     <a href=../../lib/metacat.properties>metacat.properties</a>,
138 138 
     located at:
139 
  <pre>      METACAT_HOME/lib/harvester/harvester.properties</pre>
139 
  <pre>      METACAT_HOME/lib/metacat.properties</pre>
140 140 
     where METACAT_HOME is the top-level directory that Metacat is
141 
     installed in.
141 
     installed in.
142 142 
  </p>
143 
  <p>Harvester properties are grouped together in
144 
     <a href=../../lib/metacat.properties>metacat.properties</a>, beginning
145 
     after the comment line:
146 
  <pre><code>      # Harvester properties</code></pre>
147 
  </p>
143 148 
  <p>The Harvester Administrator should edit
144 
     <a href=../../lib/harvester/harvester.properties>harvester.properties</a>,
145 
     setting appropriate values for the Metacat URL, database driver,
146 
     database connection, and other settings. The
147 
     following table is a summary of each property and its function.
149 
     <a href=../../lib/metacat.properties>metacat.properties</a>,
150 
     setting appropriate values for the <code><b>harvesterAdministrator</b></code>
151 
     property, the <code><b>smtpServer</b></code> property, and possibly other
152 
     properties. The following table is a summary of each property and its function.
148 153 
  </p>
149 154 
  <table border="1">
150 155 
    <tr>
......
164 169 
          Default: <code>true</code>
165 170 
    </tr>
166 171 
    <tr>
167 
      <td>database</td>
168 
      <td>The backend database
169 
          This setting should match the value of the <code>database</code>
170 
          property as set in the
171 
          <a href=../../build.properties>build.properties</a>
172 
          file in the associated Metacat installation.
173 
      </td>
174 
      <td><code>oracle | postgresql | sqlserver</code>
175 
      </td>
176 
    </tr>
177 
    <tr>
178 
      <td>defaultDB</td>
179 
      <td>The JDBC connection string that Metacat uses to connect to the
180 
          backend database. This setting should match the value of
181 
          the <code>jdbc-connect</code> property as set in the
182 
          <a href=../../build.properties>build.properties</a>
183 
          file in the associated Metacat installation.</td>
184 
      <td>Example:<br>
185 
          <code>jdbc:oracle:thin:@server.domain.com:1521:Metacat</code></td>
186 
    </tr>
187 
    <tr>
188 172 
      <td>delay</td>
189 173 
      <td>The number of hours that Harvester will wait before beginning its
190 174 
          first harvest. For example, if Harvester is run at  1:00 p.m., and
......
218 202 
      <td>Default: 30</td>
219 203 
    </tr>
220 204 
    <tr>
221 
      <td>metacatURL</td>
222 
      <td>The URL of the Metacat servlet to which Harvester should connect
223 
          for uploading documents.</td>
224 
      <td>Example:<br>
225 
               http://somehost.institution.edu:8080/knb/servlet/metacat</td>
226 
    </tr>
227 
    <tr>
228 
      <td>password</td>
229 
      <td>The password that Harvester uses to access the backend database.
230 
          This setting should match the value of the <code>password</code>
231 
          property as set in the
232 
          <a href=../../build.properties>build.properties</a>
233 
          file in the associated Metacat installation.
234 
      </td>
235 
      <td>&nbsp;</td>
236 
    </tr>
237 
    <tr>
238 205 
      <td>period</td>
239 206 
      <td>The number of hours between harvests. Harvester will run a new
240 207 
          harvest every <code>period</code> number of hours, until the
......
254 221 
      </td>
255 222 
    </tr>
256 223 
    <tr>
257 
      <td>user</td>
258 
      <td>The username that Metacat uses to access the backend database.
259 
          This setting should match the <code>user</code> value as set in the
260 
          <a href=../../build.properties>build.properties</a>
261 
          file in the associated Metacat installation.
262 
      </td>
263 
      <td>&nbsp;</td>
264 
    </tr>
265 
    <tr>
266 224 
      <td>Harvester Operation Properties (GetDocError, GetDocSuccess, etc.)</td>
267 225 
      <td>This group of properties is used by Harvester to report information
268 226 
          about the operations it performs for inclusion in log
......
305 263 
  </ol>
306 264 
  <p>The Harvester application will start executing. It will begin its first
307 265 
  harvest after <code><b>delay</b></code> number of hours (as specified in the
308 
  <a href=../../lib/harvester/harvester.properties>harvester.properties</a>
266 
  <a href=../../lib/metacat.properties>metacat.properties</a>
309 267 
  file). The application will continue running a new harvest every
310 268 
  <code><b>period</b></code> number of hours until a <code><b>maxHarvests</b></code>
311 269 
  number of harvests have been completed.
......
361 319 
  URL:
362 320 
  <pre>  http://somehost.somelocation.edu:8080/knb/index.jsp</pre>
363 321 
  then the Harvester Registration page would be accessed at:
364 
  <pre>  http://somehost.somelocation.edu:8080/knb/style/skins/dev/harvesterRegistrationLogin.html</pre>
322 
  <pre>  http://somehost.somelocation.edu:8080/knb/style/skins/knb/harvesterRegistrationLogin.html</pre>
365 323 
  </p>
366 324 
  <p>
367 325 
  After bringing up this page in your browser, login to your Metacat account

Also available in: Unified diff