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.

Anchor
StartMongo StartMongo

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:

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

Error

If a "NETWORK  Failed to connect to 127.0.0.1:27017" 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:

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

For Linux:

$ sudo service mongod start

Anchor
editConfig editConfig

Step 3: Edit the Aspire config/

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: http://java.com/en/download/manual.jsp
   • 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 https://wiki.searchtechnologies.com/binaries/. Select the most recent Aspire binary (aspire-distribution-X.X.zip). 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 Aspire Directory Structure.

settings.xml File

1. Go to the directory where you unpacked Aspire (such as "aspire-quick-start")

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

1. the YOUR-REGISTERED-USERNAME and YOUR-REGISTERED-PASSWORD in the settings.xml file with the username and password you used to register for Aspire.

<repositories><repository type="maven">
     <defaultVersion>2
	<defaultVersion>3.2</defaultVersion>
    
	<repository <remoteRepositories>
       <remoteRepository>
         <id>stPublic</id>
         <url>
           httptype="distribution">
		<directory>bundles/aspire</directory>
	</repository>

	<repository type="maven">
		<remoteRepositories>
			<remoteRepository>
				<id>stPublic</id>
				<url>https://repository.searchtechnologies.com/artifactory/simple/community-public/
         </url>
         				<user>YOUR-REGISTERED-USERNAME</user>
         				<password>YOUR-REGISTERED-PASSWORD</password>
       			</remoteRepository>
     		</remoteRepositories>
   </repository>

	</repository>
</repositories>

6. After you've entered your

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:

Anchor
StartupAspire StartupAspire

Step 4: Start

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.

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

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

> aspire.bat

Linux

$ aspire.sh

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

$ bin/aspire.sh

Error

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:

• Can you get to https://repository.searchtechnologies.com/artifactory/public/com/searchtechnologies/aspire/aspire-application/3.2/aspire-application-3.2.jar in a browser? 
  Enter the username/password that you entered inyour settings.xml file.
• Do you use a proxy? 
  If so, modify settings.xml to include information as described in “Proxy Settings” on the General Settings page.

Anchor
browseCSM browseCSM

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.

Anchor

addSource

addSource

Step 6: Add a New Content Source

Step 6a: Add a New FileSystem Content Source

Image Added

Step 6: Add a new File System Content 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

1. Content Source Manager Home page,

1. Add Source

1. .
2. Click

1. File System Connector

1. .

Step

6b: Specify Basic Information

Image Added

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. 
   • 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

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

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

1. • select Manually and then set up a regular crawling schedule later.
2. Click on the Action pull-down list to select one of the following: Start, Stop, Pause, or Resume.
   • This is the action that will be performed for that specific schedule.
3. Click on the Crawl pull-down list and select one of the following: Incremental, Full, Real 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 6c

: Specify the Connector Information

Image Added

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

1. 1. Containers?:

1. 1. Index containers as items. If unchecked, only files will be indexed.
   2. Scan

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

Step

6d: Specify Workflow Information

Image Added

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.

These 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

1. the Publish To File

1.  rule found under

1. the Publishers tab to

1. the onPublish

1.  Workflow tree.
   1. Specify

1. 1. a Name

1. 1.  and Description

1. 1.  for the Publisher.

1. 1. Click Add.

After completing

these steps, click

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

page.

Anchor

initiateCrawl initiateCrawl

Step 7: Initiate the

full crawl

Image Added

Now that the content source is set up, you will see a box (called a 'card') on the main page which shows your new content source. You can use the

buttons in this box to initiate a crawl.

1. Click

1. Full crawl

1.  (

1. left most black circle) to initiate the crawl.

During the Crawl

Image Added

• Click

• Refresh

• 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

• 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

Error

that will take you to a detailed error message page.

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 "publishToFile.jobs" file (which can be usually be found under the "Publish_To_File" sub-directory).

Step 8: Shut Down Aspire

Congratulations! You

Step 8: Congratulate yourself! (and shutdown)

Congratulations!!

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

Image Added

1. To

1. shut down Aspire, go to the

1. Debug Console page (http://localhost:50505/aspire)

1. .
2. Click Shutdown (the red button to the right of the server name). 

Or,

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

1. Type shutdown.
2. Press Return or Enter

Cheers!

1. .