Now that you have Maven and Java, let's configure Maven so that it understands where the Search Technologies Maven Repository is located. This is the location on the internet where all of the Aspire components are located. The URL is http://repository.searchtechnologies.com/artifactory/simple/community-public/. It is password protected.
If you have already completed this step, please go to Step 2.
Use your Aspire account to access the Maven repository. See Prerequisites for more information.
After Maven understands where the ST repository is located, Maven can download Aspire and all of its pieces automatically to create new Aspire distributions with a single command.
For more detailed documentation for creating new distributions, see Use the Maven Distribution Archetype
Now that Maven is installed, you can create a new Aspire distribution easilyy. Our recommendations are to:
The command should be executed exactly as is. Do not modify the parameters; they specify where to locate the instructions for how to build a new Aspire Distribution.
Note: Sometimes the mvn command will fail to locate the Search Technologies repository. (It should be specified in your new settings.xml file.) If this is a problem, add the following argument to the mvn command from above:
After executing the command, Maven will download a bunch of different JAR files. Most of these are various Maven plug-ins that Maven requires. These plug-ins are downloaded automatically from the "master maven repository in the sky", namely http://repo.maven.apache.org.
Finally, after Maven is ready to go, you will be prompted for the following information:
After you enter the final information and press Enter, you are prompted to confirm the entered information. Enter Y and Enter again.
So now you can run Aspire, right? Well, actually, there's one more step.
The purpose of the Maven archetype (the previous step) was to build a Maven distribution project. Essentially, this is a template distribution. Now let's use Maven to build the distribution itself.
The sequence goes like this:
Well, Aspire is meant for industrial-strength production installations. It is not a toy system. This means:
The Maven Distribution Project amply fulfills these needs. It provides a template for building copies of your distribution. Maven "profiles" can be used to customize the template for different environments, specifying different server addresses and database names for the Development environment vs the Staging environment, for example.
Okay, so let's actually build our Aspire distribution. Fortunately, this is very easy.
Again, since this is your first time running "mvn package", Maven will download a bunch of plug-ins, which it needs. But after that's done, it will build the Aspire distribution and you're ready to go.
There are a number of warning message you may see when building the distribution. Don't let this worry you. Basically, if you see the following message, everything worked.
This warning refers to the fact we don’t "hard code" the encoding for the ASCII files we use. This shouldn’t cause any issues as long as you’re not working in a language that uses extended character sets.
We changed the build process so that you could include dependencies in the pom file to cause “application bundles” to be copied from Maven in to the target bundles/aspire directory at build time. This allows Aspire to use those application bundles on hosts that do not have internet access. You've always been able to do that with component bundles. The message below tells you that you have no dependencies with the group id com.searchtechnologies.appbundles.
Some versions of Maven's mvn command produce an unwanted file and copy it to the target bundles/aspire directory . This warning indicates that your version did not (as this line warns you the file is not being excluded when things are being copied to the target directory).
This warning refers to the fact that the build is copying to a directory and cannot produce something that can be placed back in a Maven repository.
You can't run this command to build a distribution, so make sure you use mvn package (as detailed above) instead. If you use install, the build will fail and you'll see the following message.
The following diagram shows the directory structure you have created within your Maven distribution project so far:
The default Aspire distribution is a fully functional version of Aspire. Let's launch Aspire.
1. In the command window, change your working directory to: target\aspire-demo-0.1-SNAPSHOT-distribution
2. Run: bin\aspire.bat The "aspire" batch script (on Windows) or shell script (on Unix) can be modified as necessary if you want to assign more memory or need to set other JVM system properties. Example output: Aspire may take a few minutes to load all of the necessary components. You will see feedback to the command prompt during the startup. 3. Use the standard administration interface (http://localhost:50505) to install pre-packaged applications such as connectors and search engine publishers. Go to Admin UI for more details. 4. If you see an error like this: and Aspire exits: 5. Check that you have the correct username and password in the config/settings.xml file. See General Settings for details. For more information on how to start, stop, install as service, see Launch Control
The "aspire" batch script (on Windows) or shell script (on Unix) 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.
3. Use the standard administration interface (http://localhost:50505) to install pre-packaged applications such as connectors and search engine publishers.
Go to Admin UI for more details.
4. If you see an error like this:
and Aspire exits:
5. Check that you have the correct username and password in the config/settings.xml file. See General Settings for details.
For more information on how to start, stop, install as service, see Launch Control
A simple application.xml file is provided with your application. Let's go to the debug interface and start it up to see what it does.
This will start up the sample application. Aspire will take a minute or two to launch the first time because (just like Maven) Aspire will automatically download components from the Search Technologies Maven Repository. These are stored in the Maven local repository (the .m2 directory) just like Maven does.
4. You should see something that looks like this:
5. After the sample application is started, you can return to the debug console: http://localhost:50505/aspire
The debug-console provides status information and some low-level admin controls for Aspire. Through the debug console you can:
So you can see, the debug console contains quite a lot of useful functionality. Spend some time exploring it before going on to the next (and final) step.
Let's process a URL with the default pipeline.
After clicking feed, you should see the "Job status" table that indicates your job has been submitted to the Aspire pipeline.
So, the pipeline doesn't actually send the document to a search engine to index it, but it certainly could. That would only take adding one additional stage to the pipeline.
The job should take only a small fraction of a second to process. You can see that it's done (and that everything worked correctly) by refreshing the page. If it was successful, you should see "Successful" in neon green text.
You can click on the "detail" link in the job status to see the results of the pipeline. What you should see (you may need to scroll down a bit) is an XML representation of Aspire's internal document structure, which contains the result of all document processing. It will contain a <content> tag which contains the text content (from the text extraction component), http headers and web server information (from communicating with the web server at searchtechnologies.com), the <content> (added by the text extractor), and the <domainName> (extracted from the host name of the URL).
Congratulations! You have built a brand-new distribution of Aspire from scratch using the distribution archetype, and you launched the default Aspire installation and processed a URL. Cool!
Here are some suggestions on what to do next:
For example, the following is a minimal Groovy Scripting component:
You can add this component to your default Aspire configuration using the following steps: