You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@oodt.apache.org by go...@apache.org on 2011/10/11 17:32:48 UTC
svn commit: r1181843 - /oodt/site/components/maven/filemgr/user/basic.html
Author: goodale
Date: Tue Oct 11 15:32:48 2011
New Revision: 1181843
URL: http://svn.apache.org/viewvc?rev=1181843&view=rev
Log:
Commit 2 of 2 for the resolution of OODT-52. Committing the final built basic.html from the corresponding xdoc.
Modified:
oodt/site/components/maven/filemgr/user/basic.html
Modified: oodt/site/components/maven/filemgr/user/basic.html
URL: http://svn.apache.org/viewvc/oodt/site/components/maven/filemgr/user/basic.html?rev=1181843&r1=1181842&r2=1181843&view=diff
==============================================================================
--- oodt/site/components/maven/filemgr/user/basic.html (original)
+++ oodt/site/components/maven/filemgr/user/basic.html Tue Oct 11 15:32:48 2011
@@ -1,262 +1,268 @@
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Apache⢠OODT</title><link rel="stylesheet" href="http://oodt.apache.org/oodt.css" type="text/css" /><link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /><meta name="author" content="Chris Mattmann" /><meta name="author" content="Dave Woollard" /></head><body><div id="outerWrapper"><div id="innerWrapper"><div class="visualHeaderWrapper"><div class="header"><div class="apacheOODTLogo"><a href="http://oodt.apache.org/"><img src="http://oodt.apache.org/images/apacheOODT.png" alt="Apache⢠OODT" /></a></div><div class="fright"><ul class="globalnav"><!-- One of these li's must be given the currentNavTab class --><li><a id="tab-contact" href="http://oodt.apache.org/contact">Contact</a></li><li><a id="tab-development" href="http://oodt.apache.org/development">Development</a></li><li><a id="tab-download
s" href="http://oodt.apache.org/downloads">Downloads</a></li><li><a id="tab-components" href="http://oodt.apache.org/components" class="currentNavTab">Components</a></li><li><a id="tab-about" href="http://oodt.apache.org/about">About</a></li><li><a id="tab-home" href="http://oodt.apache.org/">Home</a></li></ul></div><div class="visualClear"></div></div></div><div class="subProductWrapper"><div class="subProductHeader"><h1 id="productNameSlot"><span id="bannerLeft">
-
- Catalog and Archive File Management Component
-
- </span></h1><h2 id="productSubheadSlot"><h2><a name="Introduction" id="Introduction"></a>Introduction</h2><h2><a name="Download_and_Build" id="Download_and_Build"></a>Download and Build</h2><h2><a name="Configuration_in_2_Minutes_or_Less" id="Configuration_in_2_Minutes_or_Less"></a>Configuration in 2 Minutes or Less</h2><h2><a name="Learn_By_Example" id="Learn_By_Example"></a>Learn By Example</h2><h2><a name="Conclusion" id="Conclusion"></a>Conclusion</h2></h2></div></div><div class="visualContentWrapper"><div class="contentGradient"></div><div id="content"><div class="diptych triptychSpace"><div class="visualPadding" id="leftPlate"><div class="section"><h2><a name="Introduction" id="Introduction"></a>Introduction</h2>
-<p>This document serves as a basic user's guide for the CAS File Manager
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Apache⢠OODT</title><link rel="stylesheet" href="http://oodt.apache.org/oodt.css" type="text/css" /><link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /><meta name="author" content="Chris Mattmann" /><meta name="author" content="Dave Woollard" /><meta name="Date-Revision-yyyymmdd" content="20111011" /><meta http-equiv="Content-Language" content="en" /></head><body><div id="outerWrapper"><div id="innerWrapper"><div class="visualHeaderWrapper"><div class="header"><div class="apacheOODTLogo"><a href="http://oodt.apache.org/"><img src="http://oodt.apache.org/images/apacheOODT.png" alt="Apache⢠OODT" /></a></div><div class="fright"><ul class="globalnav"><!-- One of these li's must be given the currentNavTab class --><li><a id="tab-contact" href="http://oodt.apache.org/contact">Contact</a></li><li><
a id="tab-development" href="http://oodt.apache.org/development">Development</a></li><li><a id="tab-downloads" href="http://oodt.apache.org/downloads">Downloads</a></li><li><a id="tab-components" href="http://oodt.apache.org/components" class="currentNavTab">Components</a></li><li><a id="tab-about" href="http://oodt.apache.org/about">About</a></li><li><a id="tab-home" href="http://oodt.apache.org/">Home</a></li></ul></div><div class="visualClear"></div></div></div><div class="subProductWrapper"><div class="subProductHeader"><h1 id="productNameSlot"><div id="bannerLeft">
+ Catalog and Archive File Management Component
+ </div></h1><h2 id="productSubheadSlot"><h2>Introduction<a name="Introduction" id="Introduction"></a></h2><h2>Download and Build OODT<a name="Download_and_Build_OODT" id="Download_and_Build_OODT"></a></h2><h2>Configuration in 2 Minutes or Less<a name="Configuration_in_2_Minutes_or_Less" id="Configuration_in_2_Minutes_or_Less"></a></h2><h2>Conclusion<a name="Conclusion" id="Conclusion"></a></h2></h2></div></div><div class="visualContentWrapper"><div class="contentGradient"></div><div id="content"><div class="diptych triptychSpace"><div class="visualPadding" id="leftPlate"><div class="section"><h2>Introduction<a name="Introduction" id="Introduction"></a></h2>
+
+ <p>This document serves as a basic user's guide for the CAS File Manager
project. The goal of the document is to allow users to check out, build, and
- install a base version of the CAS File Manager, as well as perform basic
- configuration tasks. For advanced topics, such as configuring the File
+ install a base version of the CAS File Manager. Additional information can
+ be found at the <a class="externalLink" href="http://cwiki.apache.org/confluence/display/OODT/OODT+Filemgr+User+Guide">
+ Filemgr User Guide Wiki Page</a>. For advanced topics, such as configuring the File
Manager to Scale and other tips and tricks, please see our
<a href="../user/advanced.html">Advanced Guide.</a></p>
-<p>The remainder of this guide is separated into the following sections:</p>
-<ul><li><a href="#section1">Download and Build</a></li>
-<li><a href="#section2">Configuration in 2 Minutes or Less</a></li>
-<li><a href="#section3">Learn By Example</a></li>
-</ul></div><a name="section1" id="section1"></a><div class="section"><h2><a name="Download_and_Build" id="Download_and_Build"></a>Download and Build</h2>
-<div class="warning"><p><b>Pre-Requisite:</b> Before you can build a copy of the CAS-File Manager you will
- need to check out and install the oodt-core project. Installing the oodt-core project
- will update your Maven2 repo with several files that are required for the CAS-File Manager.
- In order to check out and install the core follow the steps outlined below:</p>
-<div class="source"><pre>
+
+ <p>The remainder of this guide is separated into the following sections:</p>
+ <ul><li><a href="#section1">Download and Build OODT</a></li>
+ <li><a href="#section2">Configuration in 2 Minutes or Less</a></li>
+
+ </ul></div><a name="section1" id="section1"></a><div class="section"><h2>Download and Build OODT<a name="Download_and_Build_OODT" id="Download_and_Build_OODT"></a></h2>
+ <div class="info">
+ <p><b>Pre-Requisite:</b> Maven 2.x installed on your machine and Java 1.6.
+ If you have the correct versions of Java and Maven installed then proceed
+ with the build process for OODT which will also build the File Manager
+ component.
+ </p>
+ </div>
+
+ <div class="warning">
+ <p><b>Mac OS X Users:</b> Apple is now upgrading their OS to include Maven 3
+ by default, which is not compatible with Apache OODT's build process. For more
+ information on Maven, see our <a href="../development/maven.html">Maven Guide.</a>
+ To determine which version of Maven is installed on your machine type the following
+ command into a terminal.</p>
+
+ <div class="source"><pre>
+>mvn --version
+Apache Maven 2.2.1 (r801777; 2009-08-07 04:16:01+0900)
+Java version: 1.6.0_26
+ </pre></div>
+
+ <p>If your system returns Apache Maven 3.X then you will need to install Maven 2.2.1 using the
+ following steps: (NOTE: This will replace Maven 3 with Maven 2.2.1 as your systems default Maven version)</p>
+
+ <p>1. Download apache-maven-2.2.1-bin tar file from <a class="externalLink" href="http://maven.apache.org/">http://maven.apache.org</a></p>
+ <p>2. Install maven to /usr/share/</p>
+ <div class="source"><pre>
+>sudo tar xzvf apache-maven-2.2.1-bin.tar.gz -C /usr/share
+ </pre></div>
+ <p>3. Now hook it in as the default maven.</p>
+ <div class="source"><pre>
+>sudo rm /usr/bin/mvn
+>sudo rm /usr/share/maven
+>sudo ln -s /usr/share/apache-maven-2.2.1 /usr/share/maven
+>sudo ln -s /usr/share/maven/bin/mvn /usr/bin/mvn
+ </pre></div>
+ <p>4. Double check the maven version</p>
+ <div class="source"><pre>
+>mvn --version
+Apache Maven 2.2.1 ...
+ </pre></div>
+ <p><b>Now you can proceed with the check out and build of Apache OODT</b></p>
+ </div>
+ <br /><div id="checkout_build">
+ <p><b>Create a Directory to Checkout Source Code:</b></p>
+ <div class="source"><pre>
>mkdir /usr/local/src
>cd /usr/local/src
->svn co https://svn.apache.org/repos/asf/incubator/oodt/trunk/core oodt-core
- </pre>
-</div>
-<p>Once the subversion command completes you should have a directory at <code>/usr/local/src/oodt-core</code>
- which will contain a couple files. In order to build the project from this source, issue the following
- commands:</p>
-<div class="source"><pre>
->cd /usr/local/src/oodt-core
+ </pre></div>
+ <p><b>Using a Tagged Release:</b></p>
+ <div class="source"><pre>
+>svn co http://svn.apache.org/repos/asf/oodt/tags/{release_number}/ oodt
+ </pre></div>
+ <p><b>Using the Latest Development Trunk:</b></p>
+ <div class="source"><pre>
+>svn co http://svn.apache.org/repos/asf/oodt/trunk/ oodt
+ </pre></div>
+ <p>Once the subversion command completes you should have a directory at <tt>/usr/local/src/oodt</tt>
+ which will contain all of the source code for OODT. In order to build the project from source,
+ issue the following commands:</p>
+ <div class="source"><pre>
+>cd /usr/local/src/oodt
>mvn clean install
- </pre>
-</div>
-<p>Once you get the Maven Build Successful message you can proceed with the installation
- of the CAS-File Manger</p>
-</div><br /><br /><p>The most recent CAS-File Manager project can be downloaded from the Apache OODT
- <a href="http://oodt.apache.org/">website</a> or it can be checked out
- from the OODT repository using Subversion. The CAS-File Manager project is
- located at <code>https://svn.apache.org/repos/asf/incubator/oodt/trunk/filemgr/</code>.</p>
-<p>Maven is the build management system used for OODT projects. We currently
- support Maven 2.0 and later. For more information on Maven, see our
- <a href="../development/maven.html">Maven Guide.</a></p>
-<p>Assuming a *nix-like environment, with both Maven and Subversion
- clients installed and on your path, an example of the checkout and
- build process is presented below:</p>
-<div class="source"><pre>
-> mkdir /usr/local/src
-> cd /usr/local/src
-> svn checkout https://svn.apache.org/repos/asf/incubator/oodt/trunk/filemgr
- </pre>
-</div>
-<p>After the Subversion command completes, you will have the source
- for the CAS-Filemgr project in the <code>/usr/local/src/filemgr</code>
- directory.</p>
-<p>In order to build the project from this source, issue the following
- commands:</p>
-<div class="source"><pre>
-> cd /usr/local/src/filemgr
-> mvn package
- </pre>
-</div>
-<p>Note that this command performs a number of tasks, including performing
- unit tests which can take a long time depending on your system. It is not uncommon
- for this build to last ten minutes or longer. At the end of the process,
- you will see a Maven success banner.</p>
-<p>Once the Maven command completes successfully, you should have a
- <code>target</code> directory under <code>cas-filemgr-vX.Y.Z/</code>.
- The project has been built in this directory as a distribution tar ball.
- In order to move the built project out of the source directory and unpack the
- tar ball, issue the following commands:</p>
-<div class="source"><pre>
-> cd /usr/local
-> mv src/filemgr/target/cas-filemgr-vX.Y.Z-dist.tar.gz ./
-> tar -xvzf cas-filemgr-vX.Y.Z-dist.tar.gz
-> export FILEMGR_HOME=/usr/local/cas-filemgr-vX.Y.Z
- </pre>
-</div>
-<p>The resultant directory layout from the unpacked tarball is as follows:</p>
-<div class="source"><pre>
-bin/ etc/ logs/ doc/ lib/ policy/ LICENSE.txt CHANGES.txt
- </pre>
-</div>
-<p>A basic description of the files and subdirectories of the deployment is
- presented below:</p>
-<ul><li><strong>bin</strong> - contains scripts for running the File Manager,
+ </pre></div>
+ <p>Once you get the Maven Build Successful message you can proceed with the installation
+ of the CAS-FileManager.</p>
+ <div class="source"><pre>
+>mkdir /usr/local/oodt
+>cd filemgr/target
+>tar xzvf cas-filemgr-{version#}-dist.tar.gz -C /usr/local/oodt
+>cd /usr/local/oodt
+>ln -s cas-filemgr-{version#}/ cas-filemgr
+ </pre></div>
+ </div>
+ <div class="section"><h3>
+ Our latest updated File Manager documentation has moved to the OODT wiki
+ at <a class="externalLink" href="http://cwiki.apache.org/confluence/display/OODT/OODT+Filemgr+User+Guide">OODT Filemgr
+ User Guide</a>
+ <a name="Our_latest_updated_File_Manager_documentation_has_moved_to_the_OODT_wiki_________at_OODT_Filemgr________User_Guide" id="Our_latest_updated_File_Manager_documentation_has_moved_to_the_OODT_wiki_________at_OODT_Filemgr________User_Guide"></a></h3>
+
+ </div></div><br /><br /><br /><p>The resultant directory layout from the unpacked tarball is as follows:</p><div class="source"><pre>
+bin/ etc/ logs/ doc/ lib/ policy/
+ </pre></div><p>A basic description of the files and subdirectories of the deployment is
+ presented below:</p><ul><li><b>bin</b> - contains scripts for running the File Manager,
including the "filemgr" server script, and the "filemgr-client" client script.</li>
-<li><strong>etc</strong> - contains the logging.properties file for the
+
+ <li><b>etc</b> - contains the logging.properties file for the
File Manager, and the filemgr.properties file used to configure the server
options.</li>
-<li><strong>logs</strong> - the default directory into which log files are
+
+ <li><b>logs</b> - the default directory into which log files are
written.</li>
-<li><strong>doc</strong> - contains Javadoc documentation, and user guides
+
+ <li><b>doc</b> - contains Javadoc documentation, and user guides
for using the File Manager.</li>
-<li><strong>lib</strong> - the required Java jar files to run the File
+
+ <li><b>lib</b> - the required Java jar files to run the File
Manager.</li>
-<li><strong>policy</strong> - the default XML-based element and product
+
+ <li><b>policy</b> - the default XML-based element and product
type policy in case the user is using the XML Repository Manager and/or the
XML Validation Layer.</li>
-<li><strong>CHANGES.txt</strong> - contains the CHANGES present in this
- released version of the File Manager.</li>
-<li><strong>LICENSE.txt</strong> - the LICENSE for the File Manager
- project.</li>
-</ul><p>Now you have a built File Manager at <code>/usr/local/cas-filemgr-vX.Y.Z</code>.
+
+ </ul><p>Now you have a built File Manager at <tt>/usr/local/oodt/cas-filemgr</tt>.
In the next section, we will discuss how you can configure the File Manager for
- basic operations.</p>
-</div><a name="section2" id="section2"></a><div class="section"><h2><a name="Configuration_in_2_Minutes_or_Less" id="Configuration_in_2_Minutes_or_Less"></a>Configuration in 2 Minutes or Less</h2>
-<p>The reason for entitling this section "in 2 Minutes or Less" is to show that
+ basic operations.</p><a name="section2" id="section2"></a><div class="section"><h2>Configuration in 2 Minutes or Less<a name="Configuration_in_2_Minutes_or_Less" id="Configuration_in_2_Minutes_or_Less"></a></h2>
+
+ <p>The reason for entitling this section "in 2 Minutes or Less" is to show that
in it's base deployment, with vary minimal configuration, we can have the File
Manager in a usable state, capable of archiving products and capturing basic
metadata. For the record, I haven't timed it, but its pretty fast...</p>
-<p>We are going to set up the File Manager to use an XML-based Validation layer,
+
+ <p>We are going to set up the File Manager to use an XML-based Validation layer,
and XML product policy, and a Lucene metadata Catalog. The first step is to edit
- the filemgr script in <code>$FILEMGR_HOME/bin</code>. Make the following
+ the filemgr script in <tt>$FILEMGR_HOME/bin</tt>. Make the following
changes:</p>
-<ul><li>Set the <code>SERVER_PORT</code> variable to the desired port on which
+
+ <ul><li>Set the <tt>SERVER_PORT</tt> variable to the desired port on which
you'd like to run the File Manager. Our default port is 9000.</li>
-<li>Set the <code>JAVA_HOME</code> variable to point to the location of your
- installed JRE runtime. If you do not know where this is, type <code>> which
- java</code> and use that path.</li>
-<li>Set the <code>RUN_HOME</code> variable to point to the location to which
+
+ <li>Set the <tt>JAVA_HOME</tt> variable to point to the location of your
+ installed JRE runtime. If you do not know where this is, type <tt>> which
+ java</tt> and use that path.</li>
+
+ <li>Set the <tt>RUN_HOME</tt> variable to point to the location to which
you'd like the File Manager PID file written. Typically this should default to
- <code>/var/run</code>, but not all system administrators allow users to write
- to <code>/var/run</code>.</li>
-</ul><p>The second step in configuration is to edit
- <code>$FILEMGR_HOME/bin/filemgr-client</code> script, making the following
+ <tt>/var/run</tt>, but not all system administrators allow users to write
+ to <tt>/var/run</tt>.</li>
+ </ul><p>The second step in configuration is to edit
+ <tt>$FILEMGR_HOME/bin/filemgr-client</tt> script, making the following
change:</p>
-<ul><li>Set the <code>JAVA_HOME</code> variable to point to the location of
+
+ <ul><li>Set the <tt>JAVA_HOME</tt> variable to point to the location of
your installed JRE runtime.</li>
-</ul><p>In the third step of this configuration, you will set the File Manager's
+ </ul><p>In the third step of this configuration, you will set the File Manager's
various extension points. For more information about the functionality of
these extension points, see our
<a href="../development/developer.html">Developer Guide.</a> By default,
the File Manager is built to use the XML-based repository manager and
validation layer extension points, the <a class="externalLink" href="http://lucene.apache.org/">
Lucene</a>-based catalog extension point, and the local data transfer
- interface.</p>
-<p>Make the following changes to
- <code>$FILEMGR_HOME/etc/filemgr.properties</code>:</p>
-<ul><li>Specify the path to the directory where the File Manager will create the
+ interface.</p>
+
+ <p>Make the following changes to
+ <tt>$FILEMGR_HOME/etc/filemgr.properties</tt>:</p>
+
+
+ <ul><li>Specify the path to the directory where the File Manager will create the
Lucene index and associated files by setting the
- <code>org.apache.oodt.cas.filemgr.catalog.lucene.idxPath</code> property
- to <code>$FILEMGR_HOME/catalog</code>. Make sure that this directory does
+ <tt>org.apache.oodt.cas.filemgr.catalog.lucene.idxPath</tt> property
+ to <tt>$FILEMGR_HOME/catalog</tt>. Make sure that this directory does
NOT exist the first time you run the File Manager. If the File Manager does not find
a directory at the specified location, it will create all of the necessary
directory structure and ancillary files.</li>
-<li>Specify the paths to the directories where the XML policy files are stored
+
+ <li>Specify the paths to the directories where the XML policy files are stored
for the validation layer and for the repository manager. These paths are set by
- <code>org.apache.oodt.cas.filemgr.repositorymgr.dirs</code> and
- <code>org.apache.oodt.cas.filemgr.validation.dirs</code> respectively. The
+ <tt>org.apache.oodt.cas.filemgr.repositorymgr.dirs</tt> and
+ <tt>org.apache.oodt.cas.filemgr.validation.dirs</tt> respectively. The
default location (and default policy files) are located at
- <code>$FILEMGR_HOME/policy</code> in the vanilla deployment of the File Manager.
+ <tt>$FILEMGR_HOME/policy</tt> in the vanilla deployment of the File Manager.
Note that these properties need to be fully specified URLs (e.g., they should
- start with <code>file://</code>).</li>
-</ul><div class="info">Optionally, you can change the default logging properties for
+ start with <tt>file://</tt>).</li>
+ </ul><div class="info">Optionally, you can change the default logging properties for
the CAS File Manager. This is done by editing
- <code>$FILEMGR_HOME/etc/logging.properties</code>. We have tried to select sensible
+ <tt>$FILEMGR_HOME/etc/logging.properties</tt>. We have tried to select sensible
defaults for the average user, but if you would like more or less information
generated in the File Manager logs, you can edit the levels of different catagories
of information in this proporties file. The following logging levels are available:
- <code>INFO</code>, <code>WARNING</code>, <code>FINE</code>, <code>FINER</code>,
- <code>FINEST</code>, and <code>ALL</code>.</div><p>With this last step, you have configured the File Manager. In order to test your
- configuration, cd to <code>$FILEMGR_HOME/bin</code> and type:</p>
-<div class="source"><pre>
+ <tt>INFO</tt>, <tt>WARNING</tt>, <tt>FINE</tt>, <tt>FINER</tt>,
+ <tt>FINEST</tt>, and <tt>ALL</tt>.</div>
+
+ <p>With this last step, you have configured the File Manager. In order to test your
+ configuration, cd to <tt>$FILEMGR_HOME/bin</tt> and type:</p>
+
+ <div class="source"><pre>
> ./filemgr start
- </pre>
-</div>
-<p>This will startup the file manager XML-RPC server interface. Your File Manager
+ </pre></div>
+
+
+ <p>This will startup the file manager XML-RPC server interface. Your File Manager
is now ready to run! You can test out the file manager by running a simple ingest
command using the filemgr-client command below. First create a simple text file
- called "blah.txt" and place it inside <code>$FILEMGR_HOME/bin</code> Then, create
+ called "blah.txt" and place it inside <tt>$FILEMGR_HOME/bin</tt> Then, create
a blank metadata file for the product, using the
- <a class="externalLink" href="https://svn.apache.org/repos/asf/incubator/oodt/trunk/metadata/src/main/conf/cas.metadata.xsd">schema</a>
- or <a class="externalLink" href="https://svn.apache.org/repos/asf/incubator/oodt/trunk/metadata/src/main/conf/cas.metadata.dtd">DTD</a>
+ <a class="externalLink" href="http://svn.apache.org/repos/asf/oodt/trunk/metadata/src/main/conf/cas.metadata.xsd">schema</a>
+ or <a class="externalLink" href="http://svn.apache.org/repos/asf/oodt/trunk/metadata/src/main/conf/cas.metadata.dtd">DTD</a>
provided in the <a href="../../metadata">CAS-Metadata</a>
project. An example XML file might be:</p>
-<div class="source"><pre>
- <cas:metadata xmlns:cas="http://oodt.jpl.nasa.gov/1.0/cas">
+
+ <div class="source"><pre>
+ <cas:metadata xmlns:cas="http://oodt.apache.org/1.0/cas">
</cas:metadata>
- </pre>
-</div>
-<p>Call this metadata file <code>blah.txt.met</code>, and place it also in
- <code>$FILEMGR_HOME/bin</code>. Then, run the command below, assuming that you
- started the File Manager on the default port of <code>9000</code>:</p>
-<div class="source"><pre>
+ </pre></div>
+
+ <p>Call this metadata file <tt>blah.txt.met</tt>, and place it also in
+ <tt>$FILEMGR_HOME/bin</tt>. Then, run the command below, assuming that you
+ started the File Manager on the default port of <tt>9000</tt>:</p>
+
+ <div class="source"><pre>
> ./filemgr-client --url http://localhost:9000 --operation \
--ingestProduct --productName blah.txt --productStructure Flat \
--productTypeName GenericFile \
- --metadataFile file:///usr/local/cas-filemgr-v1.8.0/bin/blah.txt.met \
- --refs file:///usr/local/cas-filemgr-v1.8.0/bin/blah.txt
- </pre>
-</div>
-<p>This command triggers the ingest process. You should see a response message that
+ --metadataFile file:///usr/local/oodt/cas-filemgr/bin/blah.txt.met \
+ --refs file:///usr/local/oodt/cas-filemgr/bin/blah.txt
+ </pre></div>
+
+ <p>This command triggers the ingest process. You should see a response message that
concludes with a line similar to:</p>
-<div class="source"><pre>
+
+ <div class="source"><pre>
ingestProduct: Result: 3a812d86-148d-11db-a25a-f388f524a371
- </pre>
-</div>
-<p>If you see something similar to this message, you have successfully configured
+ </pre></div>
+
+ <p>If you see something similar to this message, you have successfully configured
the CAS File Manager, hopefully in 2 minutes or less (and even if it took a little
more time, you have to admit it was by and large painless).</p>
-</div><a name="section3" id="section3"></a><div class="section"><h2><a name="Learn_By_Example" id="Learn_By_Example"></a>Learn By Example</h2>
-<p>Coming Soon...</p>
-</div><div class="section"><h2><a name="Conclusion" id="Conclusion"></a>Conclusion</h2>
-<p>In this Basic User Guide, we have covered a number of topics, including File
+ </div><div class="section"><h2>Conclusion<a name="Conclusion" id="Conclusion"></a></h2>
+ <p>In this Basic User Guide, we have covered a number of topics, including File
Manager installation, configuration, and a basic example of use. For more advanced
topics, including the use of multiple catalogs and best practices for addressing
scaling issues, see our <a href="../user/advanced.html">Advanced Guide.</a></p>
-</div></div><div class="visualClear"></div></div><div class="triptychRight"><div class="columnBorder"><div class="visualPadding" id="rightPlate"><div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>Project Documentation</h5>
- <ul><li class="collapsed">
- <a href="../project-info.html">Project Information</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../project-reports.html">Project Reports</a>
- </li>
+ </div></div><div class="visualClear"></div></div><div class="triptychRight"><div class="columnBorder"><div class="visualPadding" id="rightPlate"><div id="navcolumn">
+
+
+ <h5>Project Documentation</h5>
+ <ul><li class="collapsed">
+ <a href="../project-info.html" title="Project Information">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html" title="Project Reports">Project Reports</a>
+ </li>
</ul><h5>Software Documentation</h5>
- <ul><li class="none">
- <a href="../development/developer.html">Developer Guide</a>
- </li>
-
- <li class="none">
- <strong>Basic User Guide</strong>
- </li>
-
- <li class="none">
- <a href="../user/advanced.html">Advanced User Guide</a>
+ <ul><li class="none">
+ <a href="../development/developer.html" title="Developer Guide">Developer Guide</a>
+ </li>
+ <li class="none">
+ <strong>Basic User Guide</strong>
</li>
+ <li class="none">
+ <a href="../user/advanced.html" title="Advanced User Guide">Advanced User Guide</a>
+ </li>
</ul>
-
-
-
-
-
-
-
-
- </div></div></div></div></div></div><div style="clear: both;">Â </div></div><div id="push"></div></div><div id="footerWrapper"><div id="footerGradient"></div><div id="footer"><a id="footerLogo" href="http://oodt.apache.org/" name="footerLogo"></a><p>
+
+
+ </div></div></div></div></div></div><div style="clear: both;">Â </div></div><div id="push"></div></div><div id="footerWrapper"><div id="footerGradient"></div><div id="footer"><a id="footerLogo" href="http://oodt.apache.org/" name="footerLogo"></a><p>
Apache⢠OODT is © 2010 by the Apache Software Foundation (ASF). Apache and the Apache
feather logo are trademarks of the ASF.
</p><p>