Page History
Anchor TutorialPrereqs TutorialPrereqs
Step 1:
TutorialPrereqs | |
TutorialPrereqs |
Prerequisites
Before you begin, you need to be registered to use Aspire (go to httphttps://aspire.searchtechnologies.com/) 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.
- 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.
- 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.
- Test that you can access the "java" command from your console.
- 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).
- At the prompt, enter the following, then press the Enter key: java -version
- 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) |
Note |
---|
This tutorial assumes the user has already set up his environment. If not, see Prerequisites. |
Anchor quickstart quickstart
Step 2: Download the Aspire quick start distribution
quickstart | |
quickstart |
Download and unpack Aspire Binaries
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)version. 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.
Anchor StartMongo StartMongo
Step 3: Start MongoDB
StartMongo | |
StartMongo |
If you haven't installed MongoDB yet, do it now: Install MongoDB 3.2
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 127.0.0.1:27017" 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 |
Anchor editConfig editConfig
Step 4: Edit the Aspire config/settings.xml
FileeditConfig | |
editConfig |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<repositories><repository type="maven"> <defaultVersion>2.2< <defaultVersion>3.0</defaultVersion> <repository type="distribution"> <directory>bundles/aspire</directory> </repository> <repository <remoteRepositories> <remoteRepository> <id>stPublic</id> <url> httptype="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> </repositories> |
Once After you've entered your user name and password, save Save and close the file. Make sure you save it so it remains a an .xml file!
Also modify the following section and point to the server where you installed MongoDB, in this case we have MongoDB running in the host called mongodb-host:
Excerpt Include | ||||
---|---|---|---|---|
|
Anchor StartupAspire StartupAspire
Step 5: Start up
Step 4: Start Up StartupAspire | |
StartupAspire |
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).
To start Aspire follow these steps:
- Open a terminal and cd to the bin/ directory inside the downloaded Aspire Distribution.
- Execute the startup script
Windows
Code Block theme FadeToGrey > aspire.bat
Linux
Code Block theme FadeToGrey $ startup.sh
OS X (this command must be executed from Aspire home directory)
Code Block theme FadeToGrey $ bin/startup.sh
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
Anchor browseCSM browseCSM
Step 6: Browse to the content source management page
browseCSM | |
browseCSM |
Step 5: Launch Aspire and open the Content Source Management Page
Launch Aspire (if it's not already running). See:
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 Introduction.Audit Logs.
Anchor addSource addSource
Step
6addSource | |
addSource |
7: Add a new
File System Content Sourcecontent source
Step 7a: Add a New FileSystem 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:
- From the Aspire
- 3 Home page, click on "Add Source" button.
- Click on "File System Connector".
Step
7b: Specify Basic Information
In the "General" tab in the
Content Source Configuration window, specify basic information for the content source:
- 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.
- Click on
- Enter a content source name in the "Name" field.
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-down- the Scheduled pulldown list and select one of the following: Manually, Periodically, Daily,Weekly or
- Advanced.
- Aspire can automatically schedule content sources to
- Advanced.
- 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.
- Click on the Action pulldown list to select one of the following: Start, Stop, Pause, or Resume.
- This is the action that will be performed for that specific schedule.
- Click on the Crawl pulldown 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.
- 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
In the "Connector" tab, specify the connection information to crawl the File System folder.
- 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/
- Check on the other options as needed:
- Index
- Enter the folder path you want to crawl.
- Containers?:
- Index containers as items. If unchecked, only files will be indexed.
- Scan
- Recursively?: Scan through subfolder's child nodes.
- Scan Excluded Item: It will scan sub items of container that have been excluded
- 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.
- For the purpose of this tutorial, drag and drop
- the Publish To File
- rule found under
- the Publishers
- tab to
- the onPublish
- Workflow tree.
- Specify
- Workflow tree.
- a Name
- and Description
- for the Publisher.
- Click Add.
After completing this steps click on
the Save then Done and you'll be sent back to the Home Page.
Add New Content Source
General Configuration
Connector Configuration
Workflow Configuration
Info |
---|
You can add more schedules by clicking in the Add New option, and rearrange the order of the schedules. |
Info |
---|
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. |
Note |
---|
Real Time and Cache Groups crawl will be available depending of the connector. |
Anchor | ||||
---|---|---|---|---|
|
Step 7: Initiate the Full Crawl
Now that the content source is set up, the crawl can be initiated.
- Click on the Full crawl
- button (
- left most black circle) to initiate the crawl.
During the Crawl
- 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.
Start Crawl by Click the left most button
Statistics
Step 9: Congratulate yourself! (and shutdown)
Congratulations!!
You have completed the 20-minute quick start. We hope it was a fun experience.
To shutdown Aspire, go to the home 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.
Cheers!
The Aspire Development Team