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 3.2 (Alder).
Tip |
---|
Make sure that the Aspire version you download matches your tutorial version. The released binaries must match the training versions. |
You must be registered to access the binaries download page. Go to How to Access Aspire , to check the Aspire Registration process.
This tutorial assumes you have already set up your environment. If not, see the Prerequisites.
Note: This is the best way to evaluate Aspire with or without premium connectors. If you are actually building a distribution, the preferred method is to use the Distribution Archetype, which requires downloading a Maven client.
The download will create a directory structure similar to that described in Directory Structure.
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
either:
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 | ||||
---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<repositories> <defaultVersion>3.2</defaultVersion> <repository type="distribution"> <directory>bundles/aspire</directory> </repository> <repository type="maven"> <remoteRepositories> <remoteRepository> <id>stPublic</id> <url>http<url>https://repository.searchtechnologies.com/artifactory/public/</url> <user>YOUR-REGISTERED-USERNAME</user> <password>YOUR-REGISTERED-PASSWORD</password> </remoteRepository> </remoteRepositories> </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 username and password, Save and close the file. Make sure you save it so it remains an .xml file!7.
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 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 | ||||
---|---|---|---|---|
|
For details on using the Aspire Content Source Management page, please refer to Admin UI Audit Logs.
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:
After 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.
ThisThese 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 and Done and and you'll be sent back to the Home page.
.
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 | ||||
---|---|---|---|---|
|
Now that the content source is set up, you will see a box (called a 'card') on the crawl can be initiatedmain page which shows your new content source. You can use the buttons in this box to initiate a crawl.
If Important: If there are errors, you will get a clickable Error that will take you to a detailed error message page.
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!
Congratulations!! You have completed the 20-minute quick start. We hope it was a fun experience.
Or, you could go to the Aspire console window (where you started Aspire with "bin\startup") and type shutdown and then press