Project

General

Profile

« Previous | Next » 

Revision 2322

Added by Matt Jones over 20 years ago

Modified the build to be smarter about making sure that the EML schemas
and styles are in place (so manually running 'geteml' should no longer
be needed), and renamed the 'loaddtdschemas' target to 'register-schemas'.
Reorganized and clarified installation instructions to make the order of
operations and dependencies clearer.

View differences:

docs/user/metacatinstall.html
366 366 
      </td>
367 367 
    </tr>
368 368 
    <tr>
369 
      <td>cvsroot</td>
370 
      <td>CVS access to retrieve latest EML. Only used by
371 
          developers in building the release.</td>
372 
      <td>Default:&nbsp;&nbsp;
373 
          <code><pre>:ext:${env.USER}@cvs.ecoinformatics.org:/cvs</pre></code>
374 
          Example:&nbsp;&nbsp;
375 
          <code><pre>:ext:myaccount@cvs.ecoinformatics.org:/cvs</pre></code>
376 
      </td>
377 
    </tr>
378 
    <tr>
379 
      <td>cvsroot-alternate</td>
380 
      <td>CVS access to retrieve latest conversion styles. Only used by
381 
          developers in building the release.</td>
382 
      <td>Default:&nbsp;&nbsp;
383 
          <code><pre>:ext:${env.USER}@cvs.nceas.ucsb.edu:/cvs/pbi</pre></code>
384 
          Example:&nbsp;&nbsp;
385 
          <code><pre>:ext:myaccount@cvs.nceas.ucsb.edu:/cvs/pbi</pre></code>
386 
      </td>
387 
    </tr>
388 
    <tr>
389 369 
      <td>default-style</td>
390 370 
      <td>The default-style parameter defines the "style-set" that is to be used
391 371 
          by default when the qformat parameter is missing or set to "html"
......
458 438 
          <code>&nbsp;</code>
459 439 
      </td>
460 440 
    </tr>
441 
    <tr>
442 
      <td>cvsroot</td>
443 
      <td>CVS access to retrieve latest EML. Only used by
444 
          developers in building the release.</td>
445 
      <td>Default:&nbsp;&nbsp;
446 
          <code><pre>:ext:${env.USER}@cvs.ecoinformatics.org:/cvs</pre></code>
447 
          Example:&nbsp;&nbsp;
448 
          <code><pre>:ext:myaccount@cvs.ecoinformatics.org:/cvs</pre></code>
449 
      </td>
450 
    </tr>
451 
    <tr>
452 
      <td>cvsroot-alternate</td>
453 
      <td>CVS access to retrieve latest conversion styles. Only used by
454 
          developers in building the release.</td>
455 
      <td>Default:&nbsp;&nbsp;
456 
          <code><pre>:ext:${env.USER}@cvs.nceas.ucsb.edu:/cvs/pbi</pre></code>
457 
          Example:&nbsp;&nbsp;
458 
          <code><pre>:ext:myaccount@cvs.nceas.ucsb.edu:/cvs/pbi</pre></code>
459 
      </td>
460 
    </tr>
461 461 
  </table>
462 462 
  <p>
463 463 
  Metacat has a number of additional settable properties in file
......
471 471 
   Note: When setting properties, DO NOT add a trailing slash [/] to the end of any paths that are specified.
472 472 
   Metacat will not function correctly if you do so.
473 473 
  </p>
474 

  		




  
  475
  
    
</td>


  		




  
  476
  
    
</tr>


  		




  
  477
  
    
</table>


  		




  
  478
  
    

  		




  
  479
  
    
<table class="tabledefault" width="100%">


  		




  
  480
  
    
<td class="tablehead" colspan="2"><p><h2>Compilation and Installation</h2></p></td>


  		




  
  481
  
    
<tr>


  		




  
  482
  
    
<td>


  		




  
  483
  
    
  <a name="protocol"></a>


  		




  
  484
  
    
  <p>


  		




  
  485
  
    
   Ant allows compilation and installation to be done in one step.


  		




  
  486
  
    
   Change into the metacat directory and type: 


  		




  
  487
  
    
   <pre><b>ant install</b></pre>


  		




  
  488
  
    
   or, if you are upgrading an existing installation, type:


  		




  
  489
  
    
   <pre><b>ant clean upgrade</b></pre>


  		




  
  490
  
    
   <p>


  		




  
  491
  
    
   You should see a bunch of messages telling you the progress of compilation


  		




  
  492
  
    
   and installation.  When it is done you should see the message 


  		




  
  493
  
    
   BUILD SUCCESSFUL


  		




  
  494
  
    
   and you should be returned to a UNIX command prompt.  If you do not see


  		




  
  495
  
    
   the message BUILD SUCCESSFUL then there was an error that you need to 


  		




  
  496
  
    
   resolve.


  		




  
  497
  
    
   This may come up if you are logged in as a user that does not have write


  		




  
  498
  
    
   access to one or more of the directories that are listed in the build.xml


  		




  
  499
  
    
   file, or if any of the paths to files are not configured correctly in the


  		




  
  500
  
    
   "config" target.


  		




  
  501
  
    
  </p>


  		




  
  502
  
    
  <p>


  		




  
  503
  
    
  Note: The 'data' directories that are indicated in the 'datafilepath' and


  		




  
  504
  
    
  'inlinedatafilepath' build properties must be writeable


  		




  
  505
  
    
  by user account under which Tomcat runs or you will not be able to upload 


  		




  
  506
  
    
  data files to the system.


  		




  
  507
  
    
  </p>


  		




  
  508
  
    

  		




  474
  509
  
    
  <p class="header"><h2>SQL Scripts</h2></p>


  		




  475
  510
  
    
  <p>


  		




  476
  511
  
    
   You now need to set up the table structure in your database.  You can do


  		




  ......




  523
  558
  
    
     UPDATED                      NUMBER(1)


  		




  524
  559
  
    
   </pre>


  		




  525
  560
  
    
  </p>


  		




  
  561
  
    
  <p class="header"><h2>Registering schemas and DTDs</h2></p>


  		




  
  562
  
    
  <p>Once the tables have been created, you should also register the Ecological


  		




  
  563
  
    
  Metadata Language (EML) DTDs and schemas. <b>However, note that you should 


  		




  
  564
  
    
  NOT do this if you are upgrading an existing installation -- the upgrade


  		




  
  565
  
    
  scripts take care of it for you (see the next section).</b>  If you are


  		




  
  566
  
    
  installing new, you can register the schema documents by running:</p>


  		




  
  567
  
    
  <pre><b>ant register-schemas</b></pre> 


  		




  
  568
  
    
  <p>This command registers the EML DTDs' and schemas' location in the 


  		




  
  569
  
    
  metacat server.  Your database username and password have to be set correctly


  		




  
  570
  
    
  for this to work.


  		




  
  571
  
    
  </p>


  		




  526
  572
  
    
  <p class="header"><h2>Upgrading SQL Scripts</h2></p>


  		




  527
  573
  
    
  <p>


  		




  528
  574
  
    
    If you have an existing metacat installation, you should not run the install


  		




  ......




  545
  591
  
    
    installation, you would only need to run the upgrade-db-to-1.4.sql script.


  		




  546
  592
  
    
   </p>


  		




  547
  593
  
    
  </p>


  		




  548
  
  
    
</td>


  		




  549
  
  
    
</tr>


  		




  550
  
  
    
</table>


  		




  551
  
  
    

  		




  552
  
  
    
<table class="tabledefault" width="100%">


  		




  553
  
  
    
<td class="tablehead" colspan="2"><p><h2>Compilation and Installation</h2></p></td>


  		




  554
  
  
    
<tr>


  		




  555
  
  
    
<td>


  		




  556
  
  
    
  <a name="protocol"></a>


  		




  557
  
  
    
  <p>


  		




  558
  
  
    
   Ant allows compilation and installation to be done in one step.


  		




  559
  
  
    
   Change into the metacat directory and type: 


  		




  560
  
  
    
   <pre><b>ant geteml install</b></pre>


  		




  561
  
  
    
   or, if you are upgrading an existing installation, type:


  		




  562
  
  
    
   <pre><b>ant clean geteml upgrade</b></pre>


  		




  563
  
  
    
   <p>


  		




  564
  
  
    
   You should see a bunch of messages telling you the progress of compilation


  		




  565
  
  
    
   and installation.  When it is done you should see the message 


  		




  566
  
  
    
   BUILD SUCCESSFUL


  		




  567
  
  
    
   and you should be returned to a UNIX command prompt.  If you do not see


  		




  568
  
  
    
   the message BUILD SUCCESSFUL then there was an error that you need to 


  		




  569
  
  
    
   resolve.


  		




  570
  
  
    
   This may come up if you are logged in as a user that does not have write


  		




  571
  
  
    
   access to one or more of the directories that are listed in the build.xml


  		




  572
  
  
    
   file, or if any of the paths to files are not configured correctly in the


  		




  573
  
  
    
   "config" target.


  		




  574
  
  
    
  </p>


  		




  575
  
  
    
  <p>Once metacat itself is installed, you should also register


  		




  576
  
  
    
  the Ecological Metadata Language (EML) DTDs and schemas. This process is done most


  		




  577
  
  
    
  easily by running:</p>


  		




  578
  
  
    
  <pre><b>ant dtdschemasql</b></pre> 


  		




  579
  
  
    
  <p>This command registers the DTDs' and schemas' location in the 


  		




  580
  
  
    
  metacat server.  Your database username and password have to be set correctly


  		




  581
  
  
    
  for this to work.


  		




  582
  
  
    
  </p>


  		




  583
  
  
    
  <p>


  		




  584
  
  
    
  Note: The 'data' directory in the installation directory must be writeable


  		




  585
  
  
    
  by whatever user is running Tomcat or you will not be able to upload data 


  		




  586
  
  
    
  files to the system.


  		




  587
  594
  
    
  <h2>Restart Tomcat</h2>


  		




  588
  595
  
    
  <p>


  		




  589
  596
  
    
   Once you have successfully installed Metacat, there is one more step.  Tomcat


  		












  

    
      build.xml
    
  





  333
  333
  
    
              excludes="**/*.sql **/stringclient/** **/client/*.java **/harvesterClient/*.java"/>


  		




  334
  334
  
    
   </target>


  		




  335
  335
  
    

  		




  336
  
  
    
   <target name="jar" depends="compile"


  		




  
  336
  
    
   <target name="jar" depends="compile,geteml"


  		




  337
  337
  
    
    description="Compiles and jars metacat java code to metacat.jar in build dir">


  		




  338
  338
  
    

  		




  339
  339
  
    
       <delete file="${build.dir}/${name}.jar" />


  		




  ......




  476
  476
  
    

  		




  477
  477
  
    

  		




  478
  478
  
    

  		




  479
  
  
    
   <target name="dtdschemasql" depends="prepare"


  		




  480
  
  
    
   description="Registers the DTDs with the new Metacat instance">


  		




  
  479
  
    
   <target name="register-schemas" depends="prepare"


  		




  
  480
  
    
   description="Registers the Schemas with a new Metacat instance">


  		




  481
  481
  
    
     <echo/>


  		




  482
  
  
    
     <echo>Registering the DTDs with the new Metacat instance...</echo>


  		




  
  482
  
    
     <echo>Registering the Schemas with the new Metacat instance...</echo>


  		




  483
  483
  
    
     <sql driver="${dbDriver}"


  		




  484
  484
  
    
          classpath="${jdbc}:${jdbc-add1}:${jdbc-add2}"


  		




  485
  485
  
    
          url="${jdbc-connect}"


  		




  ......




  488
  488
  
    
          src="${build.src}/loaddtdschema.sql" />


  		




  489
  489
  
    
   </target>


  		




  490
  490
  
    

  		




  491
  
  
    
   <target name="schemasql" depends="prepare"


  		




  492
  
  
    
            description="Registers the Schema with the new Metacat instance">


  		




  493
  
  
    
     <echo/>


  		




  494
  
  
    
     <echo>Registering the Schema with the new Metacat instance...</echo>


  		




  495
  
  
    
     <sql driver="${dbDriver}"


  		




  496
  
  
    
          classpath="${jdbc}:${jdbc-add1}:${jdbc-add2}"


  		




  497
  
  
    
          url="${jdbc-connect}"


  		




  498
  
  
    
          userid="${user}"


  		




  499
  
  
    
          password="${password}"


  		




  500
  
  
    
          src="${build.src}/loadschema.sql" />


  		




  501
  
  
    
   </target>


  		




  502
  
  
    

  		




  503
  491
  
    
   <target name="installdb" depends="prepare"


  		




  504
  492
  
    
            description="Installs the database tables">


  		




  505
  493
  
    
     <echo/>


  		












Also available in:  Unified diff