This tutorial walks through the steps necessary to crawl a JIVE community using the Aspire 2.0 Basic JIVE connector.

Step 1: Set Community Access Rights

In order to crawl the content of a community, the JIVE user that is going to be use in the crawl must have Full Control.

To set the rights for your user, do the following:

  1. Log into the Jive Admin Console.
  2. Click on People.
  3. Click on Create User.
  4. Create the user that is going to be used for crawling
  5. Click on Permissions.
  6. Click on System Administration.
  7. Set the User Overrides for the user and select Full Control (so that it has access to all Jive content).

Step 2: 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 3: Add a new JIVE Content Source



Add new source

To specify exactly what JIVE community 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 "Jive Connector".

Step 3a: 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 folder 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 3b: Specify the Connector Information



Connector Configuration Tab

In the "Connector" tab, specify the connection information to crawl the JIVE folder.

  1. Enter the community url you want to crawl.
  2. Enter the username of the user with Full Control.
  3. Enter the password of the user.

Check on the other options as needed:

  • Fetch Document Level Security?: Check if you want to fetch the document level security. These are the security properties you set when creating a content in jive.
  • Fetch Security Groups ACLs?: Check if you want to fetch the access control information (ACLs) for the places (spaces, blogs and groups). You need to the Jive Security Mapper Plug-in installed in your community for this.
  • Page Size: Indicates the maximum number of elements to retrieve per call. The maximum number is 100 and minimum is 25 due API limitations.
  • Connection Timeout: Time in seconds to wait before connection gives timeout.
  • Connection Retries: Number of retries per connection, to attempt a re-connection if the connection fails .
  • MapDB's Directory: Directory path where the mapDbs will be stored.
  • Index Specific Endpoints?: Check if you want to specify which endpoint you want to crawl. If this option is not selected the connector will crawl all the 4 endpoints.
    • People: Check if you want to crawl all the people information.
    • Places: Check if you want to crawl all the places (spaces, groups, blogs and projects.
    • Contents: Check if you want to crawl all the contents standard (documents, files, posts, polls, updates, ideas, ...) or custom.
    • Announcements: Check if you want to crawl all the announcements.
  • Use Activity Incremental?: Check if you want to do a low impact incremental that only crawls the major changes register in the Jive community. NOTE: This crawl doesn't replace the normal incremental, Activity incremental doesn't detect deletes.
    • Activity Count: Number of activity crawls performed before a normal incremental is execute.
    • Timestamp Directory: Directory path where the timestamp will be stored.
    • Set Manual Timestamp: Check this option if you want to overwrite the system timestamp with a custom timestamp.
      • Timestamp: Manual timestamp that must be in the following format "2014-01-01T00:00:00.000-0000" (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
  • Custom Metadata Options: Check this option if you want to deselect metadata calls to the API, to improve performance.
    • Fetch ModifiedBy for Documents and Files?: Unchecked this option if you don't want to make an extra call to the API to fetch the last person who modified the documents and files.
    • Fetch Owner for Tasks?: Unchecked this option if you don't want to make an extra call to the API to fetch the owner of a task.
    • Fetch Discussion's Replies?: Unchecked this option if you don't want to make extra calls to the API to add the replies of a discussion.
    • Fetch Comments?: Unchecked this option if you don't want to make extra calls to the API to add the comments of a content.
  • Include/Exclude patterns: Enter regex patterns to include or exclude files/folders based on URL matches.

Step 3b.1: Group Expasion (Optional)

In 'Advanced Connector Properties' in 'Group Expansion' you can setup the Group Expansion to expand the Security Groups (needs the Security Plugin) and the Social Groups.

  1. Select to time to schedule the Group Expansion
  2. Enter the community url you want to crawl.
  3. Enter the username of the user with Full Control.
  4. Enter the password of the user.
  5. Expand Security Groups?: Check if you want to expand the Security Groups from the JIVE Community. You need to the Jive Security Mapper Plug-in installed in your community for this.

Step 3c: 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 4: Initiate the Full Crawl



Start 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



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.

JIVE Plugin Tutorial

This tutorial walks through the steps necessary to install the Search Plugin for Jive.


Before Beginning: Admin User Account

A prerequisite for installing the plugin in the Jive community is to have a System Administrator account.



Step 1: Install the Plugin



Add Plugin

Restart Server

To install the Search Plugin for Jive, do the following:

  1. Log into the Jive Admin Console.
  2. Click on People.
  3. Click on the Tab of Plugins.
  4. Click on Add Plugin.
  5. Choose the aspire jive plugin:
  6. Click Upload.

You will need to restart the Jive SBS to take effect.

Step 2: Test the plugin



Installed Plugin

To check if the plugin was correctly installed:

  1. Log into the Jive Admin Console.
  2. Click on People.
  3. Click on the Tab of Plugins.
  4. Click on Installed Plugins.

You should see the Search Plugin for Jive in the list of plugins.

Step 2a: Test Web Service

You can easily check if the web service is up by entering the address:

If the web service is up you should get:

<ns2:getHiResponse xmlns:ns2="http://webservice.searchtechnologies.jivesoftware.com/">
   <return>It works!!!</return>
</ns2:getHiResponse>

  • No labels