Page tree

Versions Compared


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

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 3 (Alder). This tutorial will take you through installing Aspire, an Aspire connector application, and an Aspire publisher application (that simply writes to a file instead of to a search engine for indexing). It will give you an idea of how you install Aspire applications using the System Admin user interface (no programming knowledge needed).

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 tutorials for each type of connector application you might wish to install; those are located under the section for each Connector.


Table of Contents


Step 1: Prerequisites

Before you begin, you need to be registered to use Aspire (go to if you haven't already done that.

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


This tutorial assumes the user has already set up his environment, if not please refer to Prerequisites Setup

Step 2: Download the Aspire 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.

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 Directory Structure.

Step 3: Start MongoDB

If you haven't installed MongoDB yet, do it now: Install MongoDB 3.X

Make sure your MongoDB server is running by executing:

Code Block
> mongo
MongoDB shell version: 3.2.4
connecting to: test


If it returns a "NETWORK  Failed to connect to" error, it means it is not running, start it by executing:

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

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

    Code Block
    $ sudo service mongod start

Step 4: Edit the Aspire config/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.

Code Block
	<repository type="distribution">

	<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


Also uncomment the following section and point to the server where you installed MongoDB, in this case we have MongoDB running in the same server as Aspire:

Code Block
  <!-- noSql database provider for the 3.2 connector framework -->
  <noSQLConnectionProvider sslEnabled="false" sslInvalidHostNameAllowed="false">

Step 5: Start Up Aspire

First, make sure you have access to the internet so that Aspire can download components.

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
    1. Windows

      Code Block
      > startup.bat
    2. Linux or OS X

      Code Block

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


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

For more information on how to start, stop, install as service, etc. Visit: Launch Control

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


Step 6: Browse to the Content Source Management Page

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 Aspire Admin UI.


Step 7: Add a New Content Source

Step 7a: Add a New FileSystem Content Source

Add Source Menu

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 3 Home page, click on "Add Source" button.
      2. Click on "File System Connector".


Step 7b: Specify Basic Information

General Configuration

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

      1. Enter a content source name in the "Name" field. 
        1. 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 Scheduled pulldown list and select one of the following: Manually, PeriodicallyDaily,Weekly or Advanced.
        1. Aspire can automatically schedule content sources to 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 then set up a regular crawling schedule later.
      3. Click on the Action pulldown list to select one of the following: Start, StopPause, or Resume.
        1. This is the action that will be performed for that specific schedule.
      4. Click on the Crawl pulldown list and select one of the following: Incremental, FullReal Time, or Cache Groups.
        1. 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 7c: Specify the Connector Information

Connector Config

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

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


Step 7d: Specify Workflow Information


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 should an item follow after being crawled. This rules could be where to publish the document or transformations needed on the data before sending it to a search engine. See Workflow for more information.

      1. For the purpose of this tutorial, drag and drop the Publish To File rule found under the Publishers tab to the onPublish Workflow tree.
        1. Specify a Name and Description for the Publisher.
        2. Click Add.

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


You can add more schedules by clicking in the Add New option, and rearrange the order of the schedules.
If you want to disable the content source just unselect the the "Enable" checkbox. This is useful if the folder will be under maintenance and no crawls are wanted during that period of time.
Real Time and Cache Groups crawl will be available depending of the connector.


Step 8: Initiate the Full Crawl

Content Source

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

  1. Click on the Full crawl button (left most black circle) to initiate the crawl.

During the Crawl


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 9: 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 Debug Console 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