A Quick Guide to Running Your First Crawl Job

The Main Console page is displayed after you have installed Heritrix and logged into the WUI.

1. Enter the name of the new job in the text box with the "Create new job with recommended starting configuration" label.  Then click "create."
   The new job will be displayed in the list of jobs on the Main Console page.  The job will be based on the profile-defaults profile in Hertitrix 3.0. As of Heritrix 3.1, the profile-defaults profile has been eliminated. See Profiles for more information.
   
2. Click on the name of the new job and you will be taken to the job page.
   
   The name of the configuration file, crawler-beans.cxml, will be displayed at the top of the page.  Next to the name is an "edit" link. 
3. Click on the "edit" link and the contents of the configuration file will be displayed in an editable text area.
4. At this point you must enter several properties to make the job runnable. 
   1. First, add a valid value to the metadata.operatorContactUrl property, such as http://www.archive.org.
   2. Next, populate the <prop> element of the longerOverrides bean with the seed values for the crawl.  A test seed is configured for reference.  When done click "save changes" at the top of the page. For more detailed information on configuring jobs see Configuring Jobs and Profiles.
5. From the job screen, click "build."  This command will build the Spring infrastructure needed to run the job. In the Job Log the following message will display: "INFO JOB instantiated."
6. Next, click the "launch" button.  This command launches the job in "paused" mode.  At this point the job is ready to run.
7. To run the job, click the "unpause" button.  The job will now begin sending requests to the seeds of your crawl.  The status of the job will be set to "Running."  Refresh the page to see updated statistics.
   Note

• A job will not be modified if the profile or job it was based on is changed.

• Jobs based on the default profile are not ready to run as-is.  The metadata.operatorContactUrl must be set to a valid value.

Detailed information about evaluating the progress of a job can be found at Job Analysis.

Attachments:

mainconsole.png (image/png)
addjob.png (image/png)
mainconsolenewjob.png (image/png)
job.png (image/png)
cxmledit.png (image/png)
cxmloperator.png (image/png)
cxmloperator.png (image/png)
cxmlseeds.png (image/png)
build2.png (image/png)
launch.png (image/png)
unpause.png (image/png)
mainconsole.png (image/png)
newjob.png (image/png)
newjob.png (image/png)
mainconsolenewjob.png (image/png)
job.png (image/png)
cxmledit.png (image/png)
cxmleditoperator.png (image/png)
cxmledit2.png (image/png)
jobbuilt.png (image/png)
joblaunched.png (image/png)
jobunpaused.png (image/png)
cxmleditoperator[1].png (image/png)