Add a Jive Cloud source

This is for:

Developer System Administrator

When you have the required privileges, you can add the content of a Jive Cloud community to a Coveo organization.

Notes

  • Since the refreshes don’t take into account recently deleted Jive items (among other things), a source rescan or rebuild is required to capture all source content changes (see Schedule a source update).

  • While most of the parameters can be configured through the Add/Edit a Jive Cloud Source panel, other parameters, such as rarely used parameters or new parameters that aren’t yet editable through the user interface, can only be changed or added in the JSON configuration (see Edit a source JSON configuration, Add a Hidden Source Parameter, and Jive Cloud Source JSON Modification). For example, if you have issues with file download requests timing out too early for larger files, you may want to add a RequestTimeout hidden parameter in the parameters section of the source JSON configuration.
Tip
Leading practice

The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About crawling speed for information on what can impact crawling speed, as well as possible solutions.

Source key characteristics

Features Supported Additional information

Jive Cloud version

Latest version

Indexable content

Communities (also known as Spaces), social groups (also known as groups), projects, people and their profile, items (private and public), discussions (private and public), blog posts (for spaces, projects, users, groups and system blogs), announcements, polls, comments (for items, blog posts, and polls), attachments (for items, blog posts, and discussions), ideas (private and public), and videos (private and public).

Support tags and categories.

Content update operations

refresh

check

Takes place every hour by default.

A rescan or rebuild is required to retrieve:

  • Comments on comments and replies on replies (Jive REST API limitation)

  • Deleted file items (Jive REST API limitation)

  • Recently deleted Jive items

  • Properly refresh discussions

rescan

check

rebuild

check

Content security options

Same users and groups as in your content system

x

Specific users and groups

check

Everyone

check

Add a Jive Cloud source

A Jive Cloud source indexes cloud content. If you want to retrieve on-premises (server) content, see Add a Jive Server Source instead.

Follow the instructions below to add a Jive Cloud source.

  1. On the Sources (platform-ca | platform-eu | platform-au) page, click Add source.

  2. In the Add a source of content panel, click the Jive Cloud source tile.

  3. Configure your source.

Tip
Leading practice

It’s best to create or edit your source in your sandbox organization first. Once you’ve confirmed that it indexes the desired content, you can copy your source configuration to your production organization, either with a snapshot or manually.

See About non-production organizations for more information and best practices regarding sandbox organizations.

"Configuration" tab

In the Add a Jive Cloud Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.

General information

Source name

Enter a name for your source.

Tip
Leading practice

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.
Instance URL

Enter the web address of the Jive Cloud instance that you want to index.

Starting community

Optionally, enter the URL of the Jive Cloud Community where the crawling should begin. Coveo indexes the content of the communities (also known as spaces) under the starting community.

By default, the root community (also known as root space) is used.

Note

Content outside the starting community can be indexed thanks to the options in the Content to include section.
Optical character recognition (OCR)

If you want Coveo to extract text from image files or PDF files containing images, enable the appropriate option.

The extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick view. See Enable optical character recognition for details on this feature.

Allow anonymous access

Check this box to map the Everyone group in Jive Cloud to the Everyone group of the Email security identity provider.

Important

When you check this box, all items accessible to the Everyone group in Jive Cloud become public. In other words, any user (authenticated or anonymous) of your search interface can find these items in their search results.
Project

If you have the Enterprise edition, use the Project selector to associate your source with one or multiple Coveo projects.

"Authentication" section

Enter the credentials of a dedicated Jive Cloud account with Full Access permissions to your Jive Cloud instance. See Source Credentials Leading Practices.

"Content to Include" Section

Check the boxes corresponding to the content you want to index.

People

Check this box to index user profiles, personal blogs, and private items (items and discussions). Private messages (also known as direct messages) aren’t included.

Important

Since it’s not possible to apply permissions to people items, we strongly recommend that you don’t check the People box. Your Jive Cloud user profiles probably contain private information, and checking this box would make this data available to all search interface users.

Moreover, enabling this parameter significantly increases the crawling time. If you need to index people content, you should create a separate Jive Cloud source specifically to index this content.
Published items only

Check this box if you want to index only the items whose status is Published.

"Content security" tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content security.

"Access" tab

In the Access tab, set whether each group (and API key, if applicable) in your Coveo organization can view or edit the current source.

For example, when creating a new source, you could decide that members of Group A can edit its configuration while Group B can only view it.

See Custom access level for more information.

Completion

  1. Finish adding or editing your source:

    • When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add source/Save.

    • When you’re done editing the source and want to make changes effective, click Add and build source/Save and rebuild source.

      Note

      On the Sources (platform-ca | platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.

      Back on the Sources (platform-ca | platform-eu | platform-au) page, you can follow the progress of your source addition or modification.

      Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Once your source is done building or rebuilding, review the metadata Coveo is retrieving from your content.

    1. On the Sources (platform-ca | platform-eu | platform-au) page, click your source, and then click More > View and map metadata in the Action bar.

    2. If you want to use a currently not indexed metadata in a facet or result template, map it to a field.

      1. Click the metadata and then, at the top right, click Add to Index.

      2. In the Apply a mapping on all item types of a source panel, select the field you want to map the metadata to, or add a new field if none of the existing fields are appropriate.

        Notes

        • For details on configuring a new field, see Add or edit a field.

        • For advanced mapping configurations, like applying a mapping to a specific item type, see Manage mappings.

      3. Click Apply mapping.

    3. Depending on the source type you use, you may be able to extract additional metadata from your content. You can then map that metadata to a field, just like you did for the default metadata.

      More on custom metadata extraction and indexing

      Some source types let you define rules to extract metadata beyond the default metadata Coveo discovers during the initial source build.

      For example:

      Source type Custom metadata extraction methods

      Push API

      Define metadata key-value pairs in the addOrUpdate section of the PUT request payload used to upload push operations to an Amazon S3 file container.

      REST API
      and
      GraphQL API

      In the JSON configuration (REST API | GraphQL API) of the source, define metadata names (REST API | GraphQL API) and specify where to locate the metadata values in the JSON API response Coveo receives.

      Database

      Add <CustomField> elements in the XML configuration. Each element defines a metadata name and the database field to use to populate the metadata with.

      Web

      Sitemap

      Some source types automatically map metadata to default or user created fields, making the mapping process unnecessary. Some source types automatically create mappings and fields for you when you configure metadata extraction.

      See your source type documentation for more details.

    4. When you’re done reviewing and mapping metadata, return to the Sources (platform-ca | platform-eu | platform-au) page.

    5. To reindex your source with your new mappings, click Launch rebuild in the source Status column.

    6. Once the source is rebuilt, you can review its content in the Content Browser.

Required privileges

You can assign privileges to allow access to specific tools in the Coveo Administration Console. The following table indicates the privileges required to view or edit elements of the Sources (platform-ca | platform-eu | platform-au) page and associated panels. See Manage privileges and Privilege reference for more information.

Note

The Edit all privilege isn’t required to create sources. When granting privileges for the Sources domain, you can grant a group or API key the View all or Custom access level, instead of Edit all, and then select the Can Create checkbox to allow users to create sources. See Can Create ability dependence for more information.
Actions Service Domain Required access level

View sources, view source update schedules, and subscribe to source notifications

Content

Fields

View

Sources

Organization

Organization

Edit sources, edit source update schedules, and view the View and map metadata subpage

Content

Fields

Edit

Sources

Content

Source metadata

View

Organization

Organization

What’s next?