Federatedsearchinteractive

See the article Federated Search – Interactive Module or more information about this module.

Field

Description

enabled

Enable the Federatedsearchinteractive module.

producers

slug

Enter a unique name to serve as your instance url's 'slug'.

searchFor

Select what objects the producer is searching for. Only Entries is currently supported

enableLocalCache

Select "Yes" if not planning to leverage on user-personalized results, or if tested response time is not fast enough for search consumer's UX. "Yes" will cause the query/results to be cached for a longer period of time, prioritizing speed of response over freshness of data. Select "No" if plan for this producer to return results personalized for the user SSOed on the search consumer side. "No" will cause the query/results to be cached only on the API level, prioritizing freshness of data over speed.

Limit ToltemsNum

Limit number of items to return. The maximum value enforced in this module is 50.

sortBy

Select the order of items to return. If URLoverride is allowed, use "0" for "Most Recent", "1" for "Most Viewed", "2" for "Most Liked" and "3" for "Alphabetical" (e.g. /sortBy/2)

searchIn

NOTE on selecting "Only Categories/Channels Relevant to User": Results relevant to user depend on 1. The user id passed in KS by consumer, 2. User either to manage, be member of, or subscribe to, a channel/category. In case the user id is not passed, or the user is not a manager/member/subscriber of any channel, the search will fall back to All Non-Private Categories/Channels.

limitToCategoryOrChannel

Limit to results only from this category/channel. Make sure to select a category/channel from this instance's root category. If url override is allowed, pass the category id to limit by (e.g. /limitToCategoryOrChannel/1542261)

includeExtraMetadata

Select one or more metadata elements to enhance metadata results. NOTES: 1. "Custom Data" will return only metadata defined in the profile configured in the Customdata module, if enabled; 2. Checking these options may increase response time, but will allow to implement richer experiences and return more results.

stickyEntryId1

Enter an id of one of possible three entries to always appear before returned results, regardless of query/results.

stickyEntryId2

Enter an id of one of possible three entries to always appear before returned results, regardless of query/results.

stickyEntryId3

Enter an id of one of possible three entries to always appear before returned results, regardless of query/results.

allowURLOverride

Select which parameters for this type of producer can be overridden via the producer's URL.

limitToAppToken

Enter, or generate, an App Token (app-specific API key) to limit consumer calls to only those which use the right App Token.
This is considered a best-practice, not only if planning to generate multiple producers, as prevents handing the master admin API key to a BU's developers. If used, calls with a KS (Kaltura Session) not generated by this App Token will result in an error. Leave empty if planning to use a regular KS which has account-wide access.

Click "Generate" to conveniently (re)create this producer's app token, which will also include access privileges to only those areas limited to in searchIn and limitToCategoryOrChannel, if relevant. Once created, provide both the id and value to the BU's developer.

appTokenId

Generate.

appTokenValue

 

In This Article
Was this article helpful?
Thank you for your feedback!