On this page




Step 1. Launch Aspire and open the Content Source Management page

Launch Aspire (if it's not already running). See:


Step 2. Add a new Background Queue content source

To specify exactly what shared folder to crawl, we will need to create a new "Content Source".

To create a new content source:

  1. From the Content Source , click on "Add Source" button.
  2. Click on "Background Queue Connector".


If the connector is not shown, you can add a custom connector with the coordinates com.accenture.aspire:app-background-processor

Step 2a. Specify basic information


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. 
    1. 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 the Scheduled pulldown list and select one of the following: Manually, PeriodicallyDaily, Weekly or Advanced.
    1. Aspire can automatically schedule content sources to 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.
  3. Click on the Action pulldown list to select one of the following: Start, StopPause, or Resume.
    1. This is the action that will be performed for that specific schedule.
  4. Click on the Crawl pulldown list and select one of the following: Incremental, FullReal Time, or Cache Groups.
    1. 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 ? * *)

 

You can add more schedules by clicking in the Add New option, and rearrange the order of the schedules.
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.
Real Time and Cache Groups crawl will not be available for this connector.

Step 2b. Specify the connector information

In the "Connector" tab, specify the connection information to crawl the background queue.

  1. Queue
    1. Database: The name of the noSQL  database holding the queue
    2. Name: The queue name within the database
      Hint: The queue database will be prefixed with the cluster id to make it unique if more than one Aspire cluster shares the same noSQL provider. It is currently not possible to publish to a queue accessed by another Aspire cluster
  2. Queue management
    1. Delete completed queue entries: When selected, completed items are removed items from the queue. Otherwise they are just marked as completed
    2. Run indefinitely: When selected, the connector will run indefinitely, even when there are no items to process in the queue. Otherwise, it will stop once all items have been processed


Step 2c. 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.

  1. For the purpose of this tutorial, drag and drop the Publish To File rule found under the Publishers tab to the onPublish Workflow tree.
    1. Specify a Name and Description for the Publisher.
    2. Click Add.

After completing this steps click on the Save then Done and you'll be sent back to the Home Page.


Step 3: Initiate a full or incremental crawl


Now that the content source is set up, the crawl can be initiated.

  1. Click on the full or incremental crawl icons in the tile.
    1. There is no difference between a full or incremental crawl. The crawl will process items in the queue
    2. If you chose the Run Indefinitely option, the crawl will continue to run even if the queue is empty. Otherwise it will process items in the queue until there are none left and will then stop

During the Crawl

During the crawl, you can do the following:
  • 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.

Statistics are reset for every crawl.