Aspire for Elasticsearch Quick Start

Jump to: navigation, search

For Information on Aspire 3.1 Click Here

The following tutorial gets you started with Aspire for Elasticsearch in 20 minutes or less. This tutorial will take you through installing Aspire, an Aspire connector for file systems, and the Aspire Elasticsearch publisher. It will give you an idea of how you install Aspire applications using the System Admin user interface (no programming knowledge needed). Once you have completed this tutorial you can refer to the connector information and tutorials for CIFS, RDB with Incremental via Snapshots, RDB with Incremental via Table or Heritrix, listed at Connectors


Before you begin, it is assumed that you have registered for an Aspire for Elasticsearch account.(go to if you haven't already done that.

You will need your user registration name and password in order to complete this tutorial.

Step 1: Install Java

The version of Java you should use depends on the Aspire version you are targeting to:

  • Aspire 2.1.2 and earlier runs on Java 1.6 or Java 1.7
  • Aspire 2.2 and up requires to run at Java 1.7.

Note that we recommend installing the Java JDK (Java Development Kit), just in case you want to create your own Aspire Components in the future. But really, only the JRE (Java Runtime Environment) is absolutely required.

  1. Download and install the latest version of the Java JDK appropriate for the system that will run Aspire:
    • If you have a 64 bit machine, we recommend installing the 64 bit version of Java. That will allow you to create large-memory instances of Aspire.
      • The Aspire framework itself does not use up that much memory (100mb or so). But some applications may store big hash tables to improve performance, so it's best to have the 64 bit JVM (Java Virtual Machine), just in case you need it someday.
  2. Test that you can access the "java" command from your console.
    1. Open up a new DOS command-shell (go to the Start menu, enter "cmd" in the "Run" or "Search for Programs" field, and then execute the cmd.exe program).
    2. At the prompt, enter the following, then press the Enter key: java -version
    3. Success is indicated when version information is returned.

up to Aspire 2.1.2:

 > java -version
 java version "1.6.0_18"
 Java(TM) SE Runtime Environment (build 1.6.0_18-b07)
 Java HotSpot(TM) 64-Bit Server VM (build 16.0-b13, mixed mode)

or as of Aspire  (2.2 Release)  :

 > java -version
 java version "1.7.0_79"
 Java(TM) SE Runtime Environment (build 1.7.0_79-b15)
 Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode)

Step 2: Download the Quick-Start Distribution

Download and unpack For purposes of this tutorial, we'll use "aspire-quick-start" as the directory name to which you unpack Aspire.

The download will create a directory structure similar to that described in Aspire Directory Structure.

Step 3: Edit the Aspire settings.xml File

Go to the directory where you unpacked Aspire (such as "aspire-quick-start") and go to the configuration directory /config. Open the settings.xml file with a text or XML editor. Look for the maven repository tag. You need to replace the user name and password that displays with the user name and password you used to register for Aspire.

<repository type="maven">

Once you've entered your user name and password, save and close the file. Make sure you save it so it remains a .xml file

Step 4: Start Up Aspire

First, make sure you have access to the internet so that Aspire can download components. Next, still in the Aspire directory you created, change to the /bin directory and type "startup" to launch Aspire.

Note that "startup" is a batch script (on Windows) or a shell script (on Unix) that can be modified as necessary if you need more memory or need to set other system properties.

Aspire may take a few seconds to load all of the necessary components. You will see feedback to the command prompt during the startup.

Step 5: Launch Aspire and open the Content Source Management Page

Aspire Content Source Management Page

Launch Aspire (if it's not already running). See:

Browse to: http://localhost:50505. For details on using the Aspire Content Source Management page, please refer to UI Introduction.

Step 6: Add a new File System Content Source

Add new source

To specify exactly what File System folder to crawl, we will need to create a new "Content Source".

To create a new content source:

  1. From the Aspire 2 Home page, click on "Add Source" button.
  2. Click on "File System Connector".

Step 6a: Specify Basic Information

General Configuration Tab

In the "General" tab in the Add New Content Source window, specify basic information for the content source:

  1. Enter a content source name in the "Name" field.
    This is any useful name which you decide is a good name for the source. It will be displayed in the content source page, in error messages, etc.
  2. Click on the "Active?" checkbox to add a checkmark.
    Unchecking the "Active?" option allows you to configure content sources but not have them enabled. This is useful if the folder will be under maintenance and no crawls are wanted during that period of time.
  3. Click on the "Schedule" drop-down list and select one of the following: Manually, Periodically, Daily, or Weekly.
    Aspire can automatically schedule content sources to perform incremental crawls on a set schedule, such as once a day, several times a week, or periodically (every N minutes or hours).
    For the purposes of this tutorial, you may want to select Manually and then set up a regular crawling schedule later.
  4. After selecting a Schedule type, specify the details, if applicable:
    1. Manually: No additional options.
    2. Periodically: Specify the "Run every:" options by entering the number of "hours" and "minutes."
    3. Daily: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options.
    4. Weekly: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options, then clicking on the day checkboxes to specify days of the week to run the crawl.
    5. Advance: Enter a custom CRON Expression (e.g. 0 0 0 ? * *)

Step 6b: Specify the Connector Information

Connector Configuration Tab

In the "Connector" tab, specify the connection information to crawl the File System folder.

  1. Enter the folder path you want to crawl.
    For Windows: Use the following format D:\folder\folder1\
    For Linux: Use the following format /home/user/folder/folder1/
  2. Check on the other options as needed:
    1. Index folders?: index subfolders as items. If unchecked, only files will be indexed.
    2. Scan subfolders?: Scan through subfolder's child nodes.
    3. Include/Exclude patterns: Enter regex patterns to include or exclude files/folders based on URL matches.

Step 6c: Specify Workflow Information

Workflow Configuration Tab

In the "Workflow" tab, specify the workflow steps for the jobs that come out of the crawl. Drag and drop rules to determine which steps each AspireObject should follow after being crawled. At a minimum there will be a rule for where to publish the document. This is also where the rules for any transformations on the data before sending it to a search engine are established. See Workflow for more information.

  1. For the purpose of this tutorial, follow instructions starting from Step # 3 of Publish to ElasticSearch Tutorialdrag

After completing this steps click on the Save button and you'll be sent back to the Home Page.

Step 7: Initiate the Full Crawl

Start Crawl

Now that the content source is set up, the crawl can be initiated.

  1. Click on the Full crawl option (lower left of content source card) to initiate the crawl.

During the Crawl

Crawl Statistics

During the crawl, you can do the following:

  • Click on the "Refresh" button on the Content Sources page to view the latest status of the crawl.
    The status will show RUNNING while the crawl is going, and CRAWLED when it is finished.
  • Click on "Complete" to view the number of documents crawled so far, the number of documents submitted, and the number of documents with errors.

If there are errors, you will get a clickable "Error" flag that will take you to a detailed error message page.

Step 8: Congratulate yourself! (and shutdown)


You have completed the 20-minute quick start. We hope it was a fun experience.

To shutdown Aspire, go to the home page (http://localhost:50505/aspire) and click on the "Shutdown" button (that's the red button to the right of the server name). Or, you could go to the Aspire console window (where you started Aspire with "bin\startup") and type "shutdown" and then press the Return or Enter key. Either way will shut down Aspire.


The Aspire Development Team