This tutorial walks through the steps necessary to crawl Jira using the Aspire 2.0 Jira Issues connector.

Step 1: Launch Aspire and open the Content Source Management Page



Aspire Content Source Management Page

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

Browse to: http://localhost:50505. For details on using the Aspire Content Source Management page, please refer to UI Introduction.

Step 2: Add a new Jira Issues Content Source



Add new source

To specify which Jira to crawl, we will need to create a new "Content Source".

To create a new content source:

  1. From the Aspire 2 Home page, click on "Add Source" button.
  2. Click on "Jira Issues Connector".

Step 2a: Specify Basic Information



General Configuration Tab

In the "General" tab in the Add New Content Source window, specify basic information for the content source:

  1. Enter a content source name in the "Name" field.

    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 "Active?" checkbox to add a checkmark.

    Unchecking the "Active?" option allows you to configure content sources but not have them enabled. This is useful if the Jira instance will be under maintenance and no crawls are wanted during that period of time.

  3. Click on the "Schedule" drop-down list and select one of the following: Manually, Periodically, Daily, or Weekly.

    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.

  4. After selecting a Schedule type, specify the details, if applicable:
    1. Manually: No additional options.
    2. Periodically: Specify the "Run every:" options by entering the number of "hours" and "minutes."
    3. Daily: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options.
    4. 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.
    5. Advance: Enter a custom CRON Expression (e.g. 0 0 0 ? * *)

Step 2b: Specify the Connector Information



Connector Configuration Tab

In the "Connector" tab, specify the connection information to Jira.

  1. Enter the url (protocol and server) of the Jira instance.

    For example https://searchtechnologies.atlassian.net

  2. Enter the username to connect to the server with
  3. Enter the user's password
  4. Check on the other options as needed:
    1. Include/Exclude patterns: Enter regex patterns to include or exclude files/folders based on URL matches.

Step 2c: Specify Workflow Information



Workflow Configuration Tab

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 button and you'll be sent back to the Home Page.


Step 3: Initiate the Full Crawl



Start Crawl

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

  1. Click on start button to start the crawl. The StartFull.png button will start a full crawl, the StartIncr.png button will start an incremental crawl (the first time this will work like a full crawl. After the first crawl, use the StartIncr.png button (incremental) to crawl for any changes done in the repository.


During the Crawl



Crawl Statistics

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.


  • No labels