Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Follow this link if you are using Aspire for Elasticsearch

The following tutorial gets you started with Aspire in 20 minutes or less. This tutorial is for Aspire 2, if you need a tutorial for an older version (1.x), use the link Getting Started Aspire 1.x This tutorial will take you through installing Aspire

Welcome to the Getting Started Tutorial

  • Install Aspire, an Aspire connector application, and an Aspire publisher application (that
  • writes to a file instead of
  • a search engine for indexing).
It will give you
  • Get an idea of how

you install
  • to install Aspire applications using the System

Admin user interface

There is another quick start tutorial to learn how to build Aspire distributions from scratch using Maven prototypes and Maven component repositories. Quick Start with Distribution Archetype

Additionally, there are also

To use Aspire as a componentized pipeline processing system (without the Connector Framework), see the Aspire Framework Pages.


There are other tutorials for each type of


Connector application you might


want to install

; those are

located under the section for


each Connector.




Make sure that the Aspire version you download matches your tutorial version. The released binaries must match the training versions.


1. Before you begin, you


must register to

be registered to

use Aspire (go

to if you haven't already done that

to How to Access Aspire for more details).

  • You will need your user
  • registration name
  •  and password

Note: This is the best way to evaluate Aspire with or without premium connectors. The preferred method if you are actually building a distribution is to use the Distribution Archetype, which requires also downloading a Maven client.

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

Step 3: Edit the Aspire
  •  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:

Code Block
 > 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)  :

Code Block
 > 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 Select the most recent Aspire binary ( For purposes of this tutorial, we'll use "aspire-quick-start" as the directory name to which you unpack Aspire.


Review the Prerequisites to Connectors and Content Processing.

2. After registering, you'll require a valid License file. See Aspire Licensing for more details.

titleOn this page

Table of Contents

3. You will need to install MongoDB. See Installing and Configuring a Crawl Status Database for more details.

  • MongoDB is used to hold the crawl state for the Aspire Connector Framework.

Future releases (currently expected for 3.2) will allow for other databases to be used.

Step 1: Download with Pre-Built Binaries

You must be registered to access the binaries download page. Go to How to Access Aspire , to check the Aspire Registration process.

A pre-built distribution of Aspire can be downloaded from Aspire Binaries .

This distribution contains pre-built binaries for a functioning Aspire installation which works for both Windows and Linux.

After downloading Aspire, extract the contents of the zip or tar file into a directory.

Step 2: Start MongoDB

  1. If you haven't installed MongoDB, do it now: Installing and Configuring a Crawl Status Database
  2. Make sure your MongoDB server is running by executing:
Code Block
> mongo
MongoDB shell version: 3.2.4
connecting to: test


If a "NETWORK  Failed to connect to" error occurs, then it is not running.

Start it by executing:

For Windows:

Open a terminal and CD to your MongoDB installation folder and execute:

Code Block
C:\Program Files\MongoDB\Server\3.2\bin> mongod

For Linux:

Code Block
$ sudo service mongod start

Step 3: Edit the Aspire config/settings.xml File

  1. Go to the directory where you unpacked Aspire (such as "aspire-quick-start")
and go
  1. .
  2. Go to the configuration directory /config. 
  3. Open the settings.xml file with a text or XML editor. 
  4. Look for the maven repository tag. 
  5. You need to replace the
user name and password that displays with the user name
  1. YOUR-REGISTERED-USERNAME and YOUR-REGISTERED-PASSWORD in the settings.xml file with the username and password you used to register for Aspire.
<repository type="maven">
Code Block
 <defaultVersion>2	<defaultVersion>3.2</defaultVersion>
           http	<repository type="distribution">

	<repository type="maven">
Once you

If you encounter Parsing Error:  org.xml.sax.SAXParseException: Content is not allowed in prolog

This error is caused by the presence of a byte-order mark (BOM) at the start of your XML file. You can see the BOM using "od -c <filename>". Remove the BOM by copying and pasting the entire file contents to a new file in a text editor (since the BOM does not copy to the clipboard).

6. After you've entered your

user name

username and password,


Save and close the file. Make sure you save it so it remains


an .xml file!

You may also need to edit the settings if you are running MongoDB on a separate machine.

    • If this is the case, Modify the following section and point to the server where you installed MongoDB. In this case, MongoDB is running in the host called mongodb-host:

Excerpt Include
MongoDB Settings
MongoDB Settings

Step 4: Start



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.

NOTE: If you are downloading Aspire Community, ignore the error message about being unable to download the com.searchtechnologies.aspire:aspire-dcm-enterprise component. The aspire-dcm-enterprise component is available only with Enterprise systems (and is used for Distributed Processing).

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

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

from our Maven repository.

To start Aspire, follow these steps:

  1. Open a terminal and cd to the bin/ directory inside the downloaded Aspire Distribution.
  2. Execute the startup script
  • Windows
Code Block
> aspire.bat


Code Block

OS X (this command must be executed from Aspire home directory)

Code Block
$ bin/


If you are unable to start Aspire and an error occurs, try accessing a URL via the browser and logging in with your registered username/password. For example:

Excerpt Include
Aspire Quick Start with Distribution Archetype
Aspire Quick Start with Distribution Archetype

Step 5: Launch the Aspire Content Source Manager

  1. Browse to: http://localhost:50505 if you are running Aspire locally or change the host to the server hosting Aspire.

For details on using the Aspire Content Source Management page, please refer to Admin UI


Audit Logs.

Step 6: Add a

new File System

New Content Source

Step 6a: Add a New FileSystem Content Source

Add Source MenuImage Added

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
  1. Content Source Manager Home page,
click on "
  1. Add Source
" button
  1. .
  2. Click
on "
  1. File System Connector
".Step 6a
  1. .
If you want to disable the content source just clear the the Enable checkbox. This is useful if the folder will be under maintenance and no crawls are wanted during that period of time.

Step 6b: Specify Basic Information

General ConfigurationImage Added

In the




tab in the

Add New

Content Source Configuration 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.

Click on the "Schedule" drop
  1. the Scheduled pull-down list and select one of the following: Manually, Periodically, Daily,Weekly or
  1. Advanced.
    • Aspire can automatically schedule content sources to
perform incremental crawls
    • be crawled 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
    • select Manually and then set up a regular crawling schedule later.
After selecting a Schedule type
  1. Click on the Action pull-down list to select one of the following: Start, StopPause, or Resume.
    • This is the action that will be performed for that specific schedule.
  2. Click on the Crawl pull-down list and select one of the following: Incremental, FullReal Time, or Cache Groups.
    • This will be the type of crawl to execute for that specific schedule.

After selecting a Scheduled, specify the details, if applicable:

    • Manually: No additional options.
    • Periodically: Specify the "Run every:" options by entering the number of "hours" and "minutes."
    • Daily: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options.
    • 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.
    • Advanced: Enter a custom CRON Expression (e.g. 0 0 0 ? * *)
Step 6b

You can add more schedules by clicking in the Add New option. Note that you can separately schedule full crawls, incremental crawls, and user-group cache (used for group expansion with document-level security) downloads.
Real Time and Cache Groups crawl will be available depending of the connector.

Step 6c: Specify the Connector Information

Connector ConfigImage Added

In the




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
    1. Containers?:
index subfolders
    1. Index containers as items. If unchecked, only files will be indexed.
    2. Scan
    1. Recursively?: Scan through subfolder's child nodes.
    2. Scan Excluded Item: It will scan sub items of container that have been excluded
    3. Include/Exclude patterns: Enter regex patterns to include or exclude files/folders based on URL matches.



6d: Specify Workflow Information

WorkflowImage Added

In the




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 an item follow after being crawled.

At a minimum there will be a rule for

These rules could be where to publish the document

. This is also where the rules for any transformations

or transformations needed on the data before sending it to a search engine

are established


See for

 for more information.

  1. For the purpose of this tutorial, drag and drop
  1. the Publish To File
  1.  rule found under
the Publishers
  1. the Publishers tab to
  1. the onPublish
  1.  Workflow tree.
    1. Specify
    1. Name
    1.  and Description
for Click
    1.  for the Publisher.
  • Leave the default values for the number of logged jobs and the file name.
      1. Click Add.

    After completing


    these steps, click

    on the Save button

    Save and Done and you'll be sent back to the Home



    Add Source MenuImage Removed

    Add New Content Source


    Image Removed

    General Configuration


    Image Removed

    Connector Configuration


    Image Removed

    Workflow Configuration

    Step 7: Initiate the

    Full Crawl

    full crawl

    Content SourceImage Added

    Now that the content source is set up, you will see a box (called a 'card') on the

    crawl can be initiated

    main page which shows your new content source. You can use the buttons in this box to initiate a crawl.

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


    During the Crawl

    StatisticsImage Added

    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.

    Important:  If there are errors, you will get a clickable



    " flag

    that will take you to a detailed error message page.


    Image Removed

    Start Crawl by Click the left most button

    Image Removed


    Step 8: Congratulate yourself! (and shutdown)



    Checking the Output

    Because you are publishing the results to a file, you can see the published jobs in the file you specified when installing the "Publish To File" component. Typically this will be in the "logs" directory, in the "" file (which can be usually be found under the "Publish_To_File" sub-directory).

    Step 8: Shut Down Aspire

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

    ShutdownImage Added

    1. To shut down Aspire, go to the
    1. Debug Console page (http://localhost:50505/aspire)
    and click on the "Shutdown" button (that's
    1. .
    2. Click Shutdown (the red button to the right of the server name). 


    you could

    go to the Aspire console window (where you started Aspire with "bin\startup") and

    type "shutdown" and then press the

    1. Type shutdown.
    2. Press Return or Enter
    key. Either way will shut down Aspire.


    The Aspire Development Team