Establish Higher Logic User Control XML Output

Overview

Are you in the right spot? 85% of the time, FUSE clients need to establish API access to their Higher Logic instance (the preferred method). That method won’t work, however, to reach your Higher Logic-based website content if you fall into this category.

This can be confusing. Higher Logic is known for its flagship “community” (or discussion forum) feature. It also has, however, the capability to also be your entire website. Higher Logic calls this a microsite. In this sense, Higher Logic has a content management system (CMS) built-in.

As such, the information on this page applies to those organizations that are using Higher Logic as a CMS. Your organization may also be using Higher Logic in other ways too ― e.g. community discussion forums. In this scenario, FUSE will connect to all of your Higher Logic content using two different methods:

1. API [another page]. To retrieve all non-CMS content.

2. User Control [this page]. To retrieve all CMS content.

FOUR Steps

1. Create a hidden page on your site with the control hlcommon:Search. You can name the page however you prefer. We suggest something that makes it obvious later what it is alongside all of your other pages. E.g. fuse-search.

2. Ensure the following parameters are set:
   ReturnAsRestData="True" and
   ExecuteSearch="True"

3. By default, the following filters will be applied and set to True. This is recommended. You can override any of the filters individually, however, by setting them to False if you do not want FUSE to ingest that content.

   1. SearchEgroupMessages
      SearchEgroups
      SearchGlossary
      SearchMicrositeContent
      SearchMicrosites
      SearchResourceLibraries
      SearchResourceLibraryEntries
      SearchAnnouncements
      SearchBlogs
      ——-
      SearchExternalAnnouncements
      SearchExternalBlogs
      SearchExternalCalendarEventOptions
      SearchExternalCalendarEvents
      SearchExternalCommunities
      SearchExternalGlossary
      SearchExternalPageContent
      SearchExternalResourceLibraries
      SearchExternalResourceLibraryEntries
      SearchExternalRss
      SearchExternalVolunteerOpportunities
      
      The key content appears above the ‘——-’ line starting with Search ― particularly SearchMicrositeContent. The items that appear below the line ― starting with SearchExternal ― are related to Higher Logic storing copies of content you store in other systems if you had previously configured this.

4. Save the hidden page you just created and share the URL to it with FUSE (e.g. https://community.yourorganization.org/HiddenPageNameFromStepOne).

You’re done! You’ll be FUSE-ing in no time.

Authentication

If FUSE is also indexing via API, we’ll use the same credentials that you created for FUSE in Step 1.1 of our Establish Higher Logic API Access instructions to reach the page you provide to us in Step 4 above. Note that FUSE will only be able to see content via the user control you added that its account has the permissions to see.

In some rare circumstances, FUSE may only be dealing with a Higher Logic-based website and no other Higher Logic content is in play. In this scenario, if FUSE is only indexing website (i.e. microsite) content and:

• all of that content is public, no further action is required.

• some or all of that content is protected (i.e. not public content), you’ll need to create an account for us. Please follow only Step 1 of the the Establish Higher Logic API Access instructions to generate that account.

Available Fields

What follows are the fields available to FUSE when using this method. Of special note is <Tags> which is particularly useful to surface as a set of filters. This allows your users to narrow the scope of content they’re interested in.

WHAT’S HAPPENING ON TWITTER