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 simply to It will give you you install Admin user interfaceThere 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 connector wish ; those are each Before need to be registered to http://aspire.searchtechnologies.com/) if you haven't already done that registration and inYou must be registered to access the binaries download page. Go to How to Access Aspire , to check the Aspire Registration process.
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
> 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:
Code Block | ||
---|---|---|
| ||
C:\Program Files\MongoDB\Server\3.2\bin> mongod |
For Linux:
Code Block | ||
---|---|---|
| ||
$ sudo service mongod start |
Anchor | ||||
---|---|---|---|---|
|
The version of Java you should use depends on the Aspire version you are targeting to:
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.
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) |
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.
Step 3: Edit the AspireCode Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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> |
Tip |
---|
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 nameusername and password,
saveSave and close the file. Make sure you save it so it remains
aan .xml file!
You may also need to edit the settings if you are running MongoDB on a separate machine.
Excerpt Include | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
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).
from our Maven repository.
To start Aspire, follow these steps:
Code Block | ||
---|---|---|
| ||
> aspire.bat |
Linux
Code Block | ||
---|---|---|
| ||
$ aspire.sh |
OS X (this command must be executed from Aspire home directory)
Code Block | ||
---|---|---|
| ||
$ 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:
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Launch Aspire (if it's not already running). See:
For details on using the Aspire Content Source Management page, please refer to Admin UI
Introduction.Anchor | ||||
---|---|---|---|---|
|
To specify exactly what File System folder to crawl, we will need to create a new "Content Source".
To create a new content source:
Info |
---|
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. |
In the
General
tab in the
Content Source Configuration window, specify basic information for the content source:
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" dropAfter selecting
a Scheduled, specify the details, if applicable:
Info |
---|
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. |
Note |
---|
Real Time and Cache Groups crawl will be available depending of the connector. |
In the
Connector
tab, specify the connection information to crawl the File System folder.
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.
After completing
these steps, click
Save and Done and you'll be sent back to the Home
page.
Add New Content Source
General Configuration
Connector Configuration
Workflow Configuration
Anchor | ||||
---|---|---|---|---|
|
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.
Important: If there are errors, you will get a clickable
Error
that will take you to a detailed error message page.
Start Crawl by Click the left most button
Statistics
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).
Congratulations! You
Congratulations!!
You have completed the 20-minute quick start. We hope it was a fun experience.
Or,
you couldgo to the Aspire console window (where you started Aspire with "bin\startup") and
type "shutdown" and then press theCheers!
The Aspire Development Team