Plugin: Social tags
Purpose
Use this plugin if you want to be able to search for user mentions (@username) and hash-tags (#hash-tag) within your content.
This plugin extends the search query language and indexer to provide additional support for social media content.
It enables:
-
Detection of user mentions and hash-tags in content: When enabled on a data source it extracts user mentions and hash-tags from document content using a filter.
-
Query language support to search for user mentions and hash-tags: When enabled on a results page, it extends the query language to support search for hash-tags and user mentions.
| Whilst this plugin is most useful for social media data sources, it can be used with any data source to detect hash tags and user mentions. However, when using with non-social media data sources you may find it incorrectly detects hash-tags and user mentions as the content may include general text that matches the definition of a hash-tag or user mention. |
Usage
Enable the plugin
-
Select Plugins from the side navigation pane and click on the Social tags tile.
-
From the Location section, decide if you wish to enable this plugin on a data source or a results page and select the corresponding radio button.
-
Select the data source or results page to which you would like to enable this plugin from the drop-down menu.
| If enabled on a data source, the plugin will take effect as soon as the setup steps are completed, and an advanced > full update of the data source has completed. If enabled on a results page the plugin will take effect as soon as the setup steps are completed. |
Configuration settings
The configuration settings section is where you do most of the configuration for your plugin. The settings enable you to control how the plugin behaves.
| The configuration key names below are only used if you are configuring this plugin manually. The configuration keys are set in the data source or results page configuration to configure the plugin. When setting the keys manually you need to type in (or copy and paste) the key name and value. |
Disable hash tags
Configuration key |
|
Data type |
boolean |
Default value |
|
Required |
This setting is optional |
Setting this to true disables the support for processing hash tags.
Disable user tags
Configuration key |
|
Data type |
boolean |
Default value |
|
Required |
This setting is optional |
Setting this to true disables the support for processing user mentions.
| For this plugin to work correctly you must enable the plugin on any data source where you wish to detect hash-tags and user mentions, and on any results page where you wish to be able to search for these. This means at a minimum you must enable this plugin on at least one data source and one results page. |
Filter chain configuration
This plugin uses filters which are used to apply transformations to the gathered content.
The filters run in sequence and need be set in an order that makes sense. The plugin supplied filter(s) (as indicated in the listing) should be re-ordered to an appropriate point in the sequence.
| Changes to the filter order affects the way the data source processes gathered documents. See: document filters documentation. |
Examples
Consider the tweet below:
Funnelback Plugins
New #extension was added to list of @funnelbackPlugins. #extension can be enabled via admin UI.
1:35PM Sep 13, 2021You wish to provide support to your search to be able to search for things like #extensions in your search box.
To do this you need to:
-
Enable the plugin on your Twitter data source that contains the Tweet displayed above.
-
Run a full update of the Twitter data source (to detect the hash-tags and user mentions).
-
Enable the plugin on your results that handles your search.
Technical information
When the plugin is enabled on the data source that fetches this tweet the following metadata will be added:
The following metadata will be stored with document:
-
Plugin-Social-Tags-Hash-Tags:extension -
Plugin-Social-Tags-Hash-Tags-Count:2 -
Plugin-Social-Tags-User-Tags:funnelbackPlugins -
Plugin-Social-Tags-User-Tags-Count:1
If a results page includes results from this data source and has the plugin enabled, a user searching for funnelback #extensions will have search converted to search for funnelback hashTag:extensions.
In this case #extensions will only match #extensions hash-tags that have been extracted. Without the plugin enabled the query would be run as funnelback extensions and would match any page that had the words funnelback or extensions (with or without the preceding #).
The count metadata fields are useful if you wish to add reporting on hash-tags or user mentions to content auditor.