You can include content from various parts of your organization (such as blogs and events) in your community's search results. This is known as Federated Search or External Search, and it gives your community users one place where they can search for content from your organization: your Higher Logic community. Ultimately, where the content is hosted is less important than being able to find it.
You can include external content in your community search results via the Higher Logic API and RSS feeds, and you can configure both methods in your community's Settings area.
NOTE: These features are not enabled by default. If they are not available for your community, create a case.
Before setting up the Higher Logic API, review Preconfiguration for External Content below and ensure that a system admin has done the preconfiguration.
RSS Feeds
There are a few things to note about RSS feeds when creating an external search type.
- Pulling external content from an RSS feed is the easier of the two methods.
- RSS feeds are available only from the User Content and Other categories.
- RSS feeds are selectable as layouts under these categories.
- One external search type has to be created for each RSS feed.
To set up an external search:
- In the Admin Toolbar, click Admin.
- Navigate to Settings > External Content > External Search.
Preconfiguration for External Content
You'll have to use our API to send your external content to your community so that it gets included in searches.
- View our API resource page.
- Scroll down to the ExternalSearch section and click the API (POST Endpoint) for the content that you want passed into your site.
- Follow the instructions on the page.
NOTE: Each API has several Body Parameters to configure. One of these, "Code," is the unique identifier for your external content. Note and save this identifier because you'll have to enter it in the Code field when you create an external search type using the Higher Logic API.
Create an External Search Type
NOTE: The user who is logged in to the Admin interface and creates this External Search Type is considered the owner. As such, all the content from the source will display the owner's name and picture in the search results.
- Click Create.
- In the dialog, configure the following settings.
NOTE: Be sure to complete all required fields.
- Category - All content belongs to a Category and these preset categories allow users to refine their search results. Choose the Category that best represents the type of content in the feed.
NOTE: RSS feeds are available only from the User Content and Other categories.
- Layout - Each Category has a template or templates called layouts. They allow you to control what information is and is not included in the search results. If there are several, choose the one that best suits your external content.
NOTE: Select RSS Feed if you are creating an RSS feed.
- Code - This is the unique identifier for this External Search Type that was defined/passed through the API. It is used by the Higher Logic API method only; it has no bearing on RSS feeds. This cannot be changed after the type is created.
NOTE: If you're using the Higher Logic API, be sure to use the appropriate code as noted in Preconfiguration for External Content.
- Display Options - The fields that display in this section — some of which are required — will vary depending on the Category-Layout combination that you have selected.
- The Content Title / Type Label is a free-text field in which you can type a custom label for the content (i.e., its "headline").
NOTE: If you're creating an RSS Feed type, the RSS Feed URL has to be the exact URL from which the feed originates. Locate the origin of the feed and type (or paste) it's address into this field.
- Source Name lets you indicate the origin of the content, such as the external site or your organization's website.
- You can include the originating URL in the Source Link field so that users can access it (for additional information and related content) directly from the search results.
- Click Save and review the list to ensure your external search type is listed.
Edit an External Search Type
- Click Edit to the right of an external search type.
- In the dialog, you can change some of the settings.
NOTE: Be sure to complete all required fields.
- Category - You can change the Category to which this search applies.
NOTE: RSS feeds are available only from the User Content and Other categories.
- Layout - If there are multiple layouts within the Category, you can select a different one. If you have changed the category, you might have additional options in this field.
- Code - This cannot be edited after the type is created.
- Display Options - The fields that display in this section — some of which are required — will vary depending on the Category-Layout combination that you have selected.
- You can edit the Content Title / Type Label for this search.
WARNING: If you're editing an RSS Feed type, do not edit the RSS Feed URL field; it must contain the exact URL from which the feed is "broadcast." Edit this field only with the new URL if you know that the original URL has changed.
- You can edit the Source Name for this search.
- You can edit the Source Link field if the original source URL has changed.
- Click Save and review the list to ensure your external search type is listed.
Delete an External Search Type
- Click the down arrow to the right of an external search type and select Delete.
- In the dialog, review the warning and click Delete to continue; otherwise, click Cancel.
- Review the list to ensure your external search type is no longer listed.
Re-index Data
You must select the Reindex Data option when a new External Search Type is created in order for the content to be surfaced for search within Higher Logic.
NOTE: If the data does not appear in the search as anticipated, send a sample Json to your implementation Project Manager.
Clear All Data
Click Clear All Data to delete all content that is associated with this External Search Type. This is based on its unique code and is applicable to the Higher Logic API method only.
WARNING: Do not select this unless the External Search Type was used for testing and is no longer needed.
Identify External Content in Search Results
External content has a small icon (a box with an arrow) to the right of the content's title.
Integration write-backs
If your community is integrated with a third-party database, some search activities can be written to that database during the standard activity-sync process.
- Navigate to Settings > External Content > Activity Sync in the Admin interface in order to manage writeback activities on the Subscriptions tab.
To learn about the activity-sync process, see Member Activity Sync.