Once a file staging repository has been populated, it can be crawled in a similar fashion to any other repository. The connector will process updates in the repository and will publish jobs for these, with appropriate data attached. The connector can attach metadata for one or more data owner and content streams where these have been stored. Typically, the workflow for the connector will then perform some processing on the content and publish it again, either to a search engine or, in the case of some background processing tasks, back to the same staging repository.

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 File System Staging Repository 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 "File System Staging Repository Connector".

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 be available depending of the connector.

  

Step 2b. Specify the Connector Information

In the "Connector" tab, specify the connection information to crawl the File System Staging Repository.



Enter the URL of the repository. This should be the same as the URL you entered when you configured the publisher for a repository connector. In the Content source enter the name of the repository content source. The other options can be left as default.

The location is the directory on disk that will be the base directory for the repository. All information in the repository will have been stored under this directory. The content source is the content source under which the data in the repository in which you are interested is stored. If you did not configure the content source name when you installed the publisher, this will be the name of the original repository content source.

By default, the connector will process updates for all data owners for the configured content source. If you only want to process updates for certain owners (for example in a background processing configuration where the background processor only needs to process updates from the original content source and not the updates that the processor itself is writing to the repository), you can add the owners you are interested in.

You may choose what is attached to the jobs that the connector creates and publishes. By default, the connector will send only the data from the owner that made the update. For example, if there is information in the repository for the document with id www.searchtechnologies.com from two different owners (default and ocr), and an update is published by owner ocr, then only the data published by the ocr owner will be attached to the job. If you wish to change this, you may configure the owners whose data is attached to the job. If you wish all the different owners’ data to be attached to the job, you should specify the owner [all]. If you wish to add the data of the owner that published the data, you should specify the owner [item].

If your repository is using encryption, you should enter the algorithm and password to allow decryption. If you plan to use more than one Java virtual machine to access the file staging reposition at the same time (for example if you are using failover or distributed processing) you should turn on file locking to ensure the transaction log is consistent.

Real Time Updates

The connector is able to accept real time updates. To allow this, first configure the JMS server and queue on which to listen for messages. Subsequently you will be able to start a Real Time crawl on the connector. When messages are received, the connector will extract information about the updated items from the message and create jobs for these items.

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 Crawl


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

  1. Click on the crawl type option to set it as "Full" (is set as "Incremental" by default and the first time it'll work like a full crawl. After the first crawl, set it to "Incremental" to crawl for any changes done in the repository).
  2. Click on the Start button.

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.


Step 4: Initiate an Incremental Crawl


If you only want to process content updates from the File System Staging Repository (documents which are added, modified, or removed), then click on the "Incremental" button instead of the "Full" button. The File System Staging Repository connector will automatically identify only changes which have occurred since the last crawl.

If this is the first time that the connector has crawled, the action of the "Incremental" button depends on the exact method of change discovery. It may perform the same action as a "Full" crawl crawling everything, or it may not crawl anything. Thereafter, the Incremental button will only crawl updates.

Statistics are reset for every crawl.