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 Confluence Identity Content Source (Confluence User and Group 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 "Custom", as the Confluence User And Group Connector is an Aspire Premium feature.
  3. On the Repository tab, set Group id to com.accenture.aspire and Artifact id to aspire-confluence-userAndGroups-source. You can leave the version blank unless specified.
  4. Click OK. As soon as the download finishes, the Content Source Configuration window will appear.


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, Periodically, Daily, 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, Stop, Pause, 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, Full, Real 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 Confluence Identity.

  1. Confluence url: URL to access the Confluence server in the form of: http://{servername}{:port}. In some Confluence installations you must add "/confluence" to the end of the server name – e.g http://wiki.local.search/confluence . The connector uses REST API to communicate with Confluence. To verify REST append /rest/api/space at the end of the URL. Test it in a browser.

  2. Domain: Domain used to login to Confluence. If the domain is not required by the environment it is ignored.

  3. Username: Username with admin privileges to access all Confluence content, this will be the user used to crawl the Confluence instance. i.e part of the confluence-admin group

  4. Password: Password

  5. Use login.action.form: Use login.action POST action to authenticate instead of using BASIC Authorization headers

  6. ---------------------------------------------------------------------------------------------------------------------------
  7. Include users: Select to include users in the crawl
  8. All Users Group(s): The group(s) that contains all Confluence server users - use comma delimited values for multiple entries. Drives the selection of the entire set of users.
  9. Populate User Email: Confluence provides a prototype API to retrieve a user's email. Check this box if the API should be used to populate the user's email field. The email will be populated in the displayUrl field in the Aspire output object.
  10. ----------------------------------------------------------------------------------------------------------------------------
  11. Include groups: Select to include groups in the crawl.
  12. Group(s) selection: The group(s) that should be included - use comma delimited values for multiple entries. Nothing here means all groups.
  13. Ingest Only Groups In ACLs: Select to ingest only groups in ACLs.
  14. Content Sources: Confluence connector Content Sources Databases: a comma delimited list of content sources ids that should have their aclMaps collections queried to see if the groups exist in ACLs
  15. Publish Scope: Group related entities that should be sent for processing to the connector workflow:
    1. Publish Groups Only
    2. Publish Members Only
    3. Publish Groups And Members
  16. ------------------------------------------------------------------------------------------------------------------------------
  17. Page Result Set Limit: The maximum number of records to be retrieved at a time per page through the Confluence REST API.
  18. ------------------------------------------------------------------------------------------------------------------------------
  19. Scan excluded items: Select so that the scanner will scan sub items of container items excluded by a pattern (because it matches an exclude pattern or because it doesn't match an include pattern).
  20. Include patterns: Specify regex display URL patterns to include
  21. Exclude patterns: Specify regex display URL patterns to exclude
  22. -------------------------------------------------------------------------------------------------------------------------------
  23. Connection timeout: Maximum time to wait (in millis) for the connection
  24. Read timeout: Maximum time to wait for read (in millis)
  25. Retry policy:
    1. Always use the same delay (retryDelay) - fixed,
    2. Multiple the retryDelay by the times we have attempted this call (up to maxRetryDelay) - increasing,
    3. Increase the delay by a factor (retryDelayMultiplier) of the retryDelay everytime a call is made - cumulative
  26. Retries: Maximum number of retries a failed document
  27. Retry delay: Retry delay (in millis)
  28. Maximum retry delay: Maximum retry delay (in millis)
  29. Retry delay multiplier
  30. -------------------------------------------------------------------------------------------------------------------------------
  31. Ignore scan errors: If selected, the scanning errors won't stop the crawl from continuing, but they are still going to be logged.

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 Confluence Identity (documents which are added, modified, or removed), then click on the "Incremental" button instead of the "Full" button. The Confluence Identity 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.